Reference documentation and code samples for the Google Cloud Api Hub V1 Client class PluginInstanceAction.
PluginInstanceAction represents an action which can be executed in the plugin instance.
Generated from protobuf message google.cloud.apihub.v1.PluginInstanceAction
Namespace
Google \ Cloud \ ApiHub \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ hub_instance_action
ExecutionStatus
Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
↳ action_id
↳ state
int
Output only. The current state of the plugin action in the plugin instance.
↳ schedule_cron_expression
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.
↳ curation_config
CurationConfig
Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
↳ schedule_time_zone
string
Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
↳ service_account
string
Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
↳ resource_config
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.
getHubInstanceAction
Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
hasHubInstanceAction
setHubInstanceAction
Optional. The execution information for the plugin instance action done corresponding to an API hub instance.
$this
getActionId
Required. This should map to one of the action id specified in actions_config in the plugin.
string
setActionId
Required. This should map to one of the action id specified in actions_config in the plugin.
var
string
$this
getState
Output only. The current state of the plugin action in the plugin instance.
setState
Output only. The current state of the plugin action in the plugin instance.
$this
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
setScheduleCronExpression
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.
var
string
$this
getCurationConfig
Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
hasCurationConfig
clearCurationConfig
setCurationConfig
Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.
$this
getScheduleTimeZone
Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
string
setScheduleTimeZone
Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.
var
string
$this
getServiceAccount
Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
string
setServiceAccount
Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.
var
string
$this
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.
hasResourceConfig
clearResourceConfig
setResourceConfig
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.
$this
getActionStatus
string
