Interface PluginInstanceActionOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PluginInstanceAction, PluginInstanceAction.Builder

@Generated public interface PluginInstanceActionOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • hasHubInstanceAction

      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];
      Returns:
      Whether the hubInstanceAction field is set.
    • getHubInstanceAction

      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];
      Returns:
      The hubInstanceAction.
    • getHubInstanceActionOrBuilder

      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];
    • getActionId

      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];
      Returns:
      The actionId.
    • getActionIdBytes

      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];
      Returns:
      The bytes for actionId.
    • getStateValue

      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];
      Returns:
      The enum numeric value on the wire for 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];
      Returns:
      The state.
    • getScheduleCronExpression

      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];
      Returns:
      The scheduleCronExpression.
    • getScheduleCronExpressionBytes

      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];
      Returns:
      The bytes for scheduleCronExpression.
    • hasCurationConfig

      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];
      Returns:
      Whether the curationConfig field is set.
    • getCurationConfig

      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];
      Returns:
      The curationConfig.
    • getCurationConfigOrBuilder

      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];
    • getScheduleTimeZone

      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];
      Returns:
      The scheduleTimeZone.
    • getScheduleTimeZoneBytes

      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];
      Returns:
      The bytes for scheduleTimeZone.
    • getServiceAccount

      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];
      Returns:
      The serviceAccount.
    • getServiceAccountBytes

      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];
      Returns:
      The bytes for serviceAccount.
    • hasResourceConfig

      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];
      Returns:
      Whether the resourceConfig field is set.
    • 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];
      Returns:
      The resourceConfig.
    • getResourceConfigOrBuilder

      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];
    • getActionStatusCase