Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::PluginInstanceAction.
PluginInstanceAction represents an action which can be executed in the plugin instance.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#action_id
def action_id() -> ::String
Returns
- (::String) — Required. This should map to one of the [action id][google.cloud.apihub.v1.PluginActionConfig.id] specified in actions_config in the plugin.
#action_id=
def action_id=(value) -> ::String
Parameter
- value (::String) — Required. This should map to one of the [action id][google.cloud.apihub.v1.PluginActionConfig.id] specified in actions_config in the plugin.
Returns
- (::String) — Required. This should map to one of the [action id][google.cloud.apihub.v1.PluginActionConfig.id] specified in actions_config in the plugin.
#curation_config
def curation_config() -> ::Google::Cloud::ApiHub::V1::CurationConfig
Returns
- (::Google::Cloud::ApiHub::V1::CurationConfig) — Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
#curation_config=
def curation_config=(value) -> ::Google::Cloud::ApiHub::V1::CurationConfig
Parameter
- value (::Google::Cloud::ApiHub::V1::CurationConfig) — Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
Returns
- (::Google::Cloud::ApiHub::V1::CurationConfig) — Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
#hub_instance_action
def hub_instance_action() -> ::Google::Cloud::ApiHub::V1::ExecutionStatus
Returns
- (::Google::Cloud::ApiHub::V1::ExecutionStatus) — Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
#hub_instance_action=
def hub_instance_action=(value) -> ::Google::Cloud::ApiHub::V1::ExecutionStatus
Parameter
- value (::Google::Cloud::ApiHub::V1::ExecutionStatus) — Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
Returns
- (::Google::Cloud::ApiHub::V1::ExecutionStatus) — Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
#resource_config
def resource_config() -> ::Google::Cloud::ApiHub::V1::PluginInstanceAction::ResourceConfig
Returns
- (::Google::Cloud::ApiHub::V1::PluginInstanceAction::ResourceConfig) — 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.
#schedule_cron_expression
def schedule_cron_expression() -> ::String
Returns
- (::String) — 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.
#schedule_cron_expression=
def schedule_cron_expression=(value) -> ::String
Parameter
- value (::String) — 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.
Returns
- (::String) — 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.
#schedule_time_zone
def schedule_time_zone() -> ::String
Returns
- (::String) — Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
#schedule_time_zone=
def schedule_time_zone=(value) -> ::String
Parameter
- value (::String) — Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
Returns
- (::String) — Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
#service_account
def service_account() -> ::String
Returns
- (::String) — Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
#service_account=
def service_account=(value) -> ::String
Parameter
- value (::String) — Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
Returns
- (::String) — Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
#state
def state() -> ::Google::Cloud::ApiHub::V1::PluginInstanceAction::State
Returns
- (::Google::Cloud::ApiHub::V1::PluginInstanceAction::State) — Output only. The current state of the plugin action in the plugin instance.