Class PluginInstanceAction

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.PluginInstanceAction
All Implemented Interfaces:
PluginInstanceActionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class PluginInstanceAction extends com.google.protobuf.GeneratedMessage implements PluginInstanceActionOrBuilder
 PluginInstanceAction represents an action which can be executed in the plugin
 instance.
 
Protobuf type google.cloud.apihub.v1.PluginInstanceAction
See Also:
  • Field Details

    • HUB_INSTANCE_ACTION_FIELD_NUMBER

      public static final int HUB_INSTANCE_ACTION_FIELD_NUMBER
      See Also:
    • ACTION_ID_FIELD_NUMBER

      public static final int ACTION_ID_FIELD_NUMBER
      See Also:
    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:
    • SCHEDULE_CRON_EXPRESSION_FIELD_NUMBER

      public static final int SCHEDULE_CRON_EXPRESSION_FIELD_NUMBER
      See Also:
    • CURATION_CONFIG_FIELD_NUMBER

      public static final int CURATION_CONFIG_FIELD_NUMBER
      See Also:
    • SCHEDULE_TIME_ZONE_FIELD_NUMBER

      public static final int SCHEDULE_TIME_ZONE_FIELD_NUMBER
      See Also:
    • SERVICE_ACCOUNT_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_FIELD_NUMBER
      See Also:
    • RESOURCE_CONFIG_FIELD_NUMBER

      public static final int RESOURCE_CONFIG_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getActionStatusCase

      public PluginInstanceAction.ActionStatusCase getActionStatusCase()
      Specified by:
      getActionStatusCase in interface PluginInstanceActionOrBuilder
    • hasHubInstanceAction

      public boolean hasHubInstanceAction()
       Optional. The execution information for the plugin instance action done
       corresponding to an API hub instance.
       
      .google.cloud.apihub.v1.ExecutionStatus hub_instance_action = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasHubInstanceAction in interface PluginInstanceActionOrBuilder
      Returns:
      Whether the hubInstanceAction field is set.
    • getHubInstanceAction

      public ExecutionStatus getHubInstanceAction()
       Optional. The execution information for the plugin instance action done
       corresponding to an API hub instance.
       
      .google.cloud.apihub.v1.ExecutionStatus hub_instance_action = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHubInstanceAction in interface PluginInstanceActionOrBuilder
      Returns:
      The hubInstanceAction.
    • getHubInstanceActionOrBuilder

      public ExecutionStatusOrBuilder getHubInstanceActionOrBuilder()
       Optional. The execution information for the plugin instance action done
       corresponding to an API hub instance.
       
      .google.cloud.apihub.v1.ExecutionStatus hub_instance_action = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHubInstanceActionOrBuilder in interface PluginInstanceActionOrBuilder
    • getActionId

      public String getActionId()
       Required. This should map to one of the [action
       id][google.cloud.apihub.v1.PluginActionConfig.id] specified in
       [actions_config][google.cloud.apihub.v1.Plugin.actions_config] in the
       plugin.
       
      string action_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getActionId in interface PluginInstanceActionOrBuilder
      Returns:
      The actionId.
    • getActionIdBytes

      public com.google.protobuf.ByteString getActionIdBytes()
       Required. This should map to one of the [action
       id][google.cloud.apihub.v1.PluginActionConfig.id] specified in
       [actions_config][google.cloud.apihub.v1.Plugin.actions_config] in the
       plugin.
       
      string action_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getActionIdBytes in interface PluginInstanceActionOrBuilder
      Returns:
      The bytes for actionId.
    • getStateValue

      public int getStateValue()
       Output only. The current state of the plugin action in the plugin instance.
       
      .google.cloud.apihub.v1.PluginInstanceAction.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface PluginInstanceActionOrBuilder
      Returns:
      The enum numeric value on the wire for state.
    • getState

      public PluginInstanceAction.State getState()
       Output only. The current state of the plugin action in the plugin instance.
       
      .google.cloud.apihub.v1.PluginInstanceAction.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface PluginInstanceActionOrBuilder
      Returns:
      The state.
    • getScheduleCronExpression

      public String getScheduleCronExpression()
       Optional. The schedule for this plugin instance action. This can only be
       set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
       
      string schedule_cron_expression = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getScheduleCronExpression in interface PluginInstanceActionOrBuilder
      Returns:
      The scheduleCronExpression.
    • getScheduleCronExpressionBytes

      public com.google.protobuf.ByteString getScheduleCronExpressionBytes()
       Optional. The schedule for this plugin instance action. This can only be
       set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action.
       
      string schedule_cron_expression = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getScheduleCronExpressionBytes in interface PluginInstanceActionOrBuilder
      Returns:
      The bytes for scheduleCronExpression.
    • hasCurationConfig

      public boolean hasCurationConfig()
       Optional. This configuration should be provided if the plugin action is
       publishing data to API hub curate layer.
       
      .google.cloud.apihub.v1.CurationConfig curation_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasCurationConfig in interface PluginInstanceActionOrBuilder
      Returns:
      Whether the curationConfig field is set.
    • getCurationConfig

      public CurationConfig getCurationConfig()
       Optional. This configuration should be provided if the plugin action is
       publishing data to API hub curate layer.
       
      .google.cloud.apihub.v1.CurationConfig curation_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCurationConfig in interface PluginInstanceActionOrBuilder
      Returns:
      The curationConfig.
    • getCurationConfigOrBuilder

      public CurationConfigOrBuilder getCurationConfigOrBuilder()
       Optional. This configuration should be provided if the plugin action is
       publishing data to API hub curate layer.
       
      .google.cloud.apihub.v1.CurationConfig curation_config = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCurationConfigOrBuilder in interface PluginInstanceActionOrBuilder
    • getScheduleTimeZone

      public String getScheduleTimeZone()
       Optional. The time zone for the schedule cron expression. If not provided,
       UTC will be used.
       
      string schedule_time_zone = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getScheduleTimeZone in interface PluginInstanceActionOrBuilder
      Returns:
      The scheduleTimeZone.
    • getScheduleTimeZoneBytes

      public com.google.protobuf.ByteString getScheduleTimeZoneBytes()
       Optional. The time zone for the schedule cron expression. If not provided,
       UTC will be used.
       
      string schedule_time_zone = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getScheduleTimeZoneBytes in interface PluginInstanceActionOrBuilder
      Returns:
      The bytes for scheduleTimeZone.
    • getServiceAccount

      public String getServiceAccount()
       Optional. The service account used to publish data. Note, the service
       account will only be accepted for non GCP plugins like OPDK.
       
      string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getServiceAccount in interface PluginInstanceActionOrBuilder
      Returns:
      The serviceAccount.
    • getServiceAccountBytes

      public com.google.protobuf.ByteString getServiceAccountBytes()
       Optional. The service account used to publish data. Note, the service
       account will only be accepted for non GCP plugins like OPDK.
       
      string service_account = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getServiceAccountBytes in interface PluginInstanceActionOrBuilder
      Returns:
      The bytes for serviceAccount.
    • hasResourceConfig

      public boolean hasResourceConfig()
       Output only. The configuration of resources created for a given plugin
       instance action. Note these will be returned only in case of Non-GCP
       plugins like OPDK.
       
      .google.cloud.apihub.v1.PluginInstanceAction.ResourceConfig resource_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasResourceConfig in interface PluginInstanceActionOrBuilder
      Returns:
      Whether the resourceConfig field is set.
    • getResourceConfig

      public PluginInstanceAction.ResourceConfig getResourceConfig()
       Output only. The configuration of resources created for a given plugin
       instance action. Note these will be returned only in case of Non-GCP
       plugins like OPDK.
       
      .google.cloud.apihub.v1.PluginInstanceAction.ResourceConfig resource_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getResourceConfig in interface PluginInstanceActionOrBuilder
      Returns:
      The resourceConfig.
    • getResourceConfigOrBuilder

      public PluginInstanceAction.ResourceConfigOrBuilder getResourceConfigOrBuilder()
       Output only. The configuration of resources created for a given plugin
       instance action. Note these will be returned only in case of Non-GCP
       plugins like OPDK.
       
      .google.cloud.apihub.v1.PluginInstanceAction.ResourceConfig resource_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getResourceConfigOrBuilder in interface PluginInstanceActionOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static PluginInstanceAction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstanceAction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstanceAction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstanceAction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstanceAction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstanceAction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PluginInstanceAction parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PluginInstanceAction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PluginInstanceAction parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PluginInstanceAction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PluginInstanceAction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PluginInstanceAction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public PluginInstanceAction.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static PluginInstanceAction.Builder newBuilder()
    • newBuilder

      public static PluginInstanceAction.Builder newBuilder(PluginInstanceAction prototype)
    • toBuilder

      public PluginInstanceAction.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected PluginInstanceAction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static PluginInstanceAction getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PluginInstanceAction> parser()
    • getParserForType

      public com.google.protobuf.Parser<PluginInstanceAction> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public PluginInstanceAction getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder