Google Cloud Api Hub V1 Client - Class PluginInstanceAction (0.3.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`string` Required. This should map to one of the action id specified in actions_config in the plugin.
`↳ 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.

Returns
Type	Description
`ExecutionStatus\|null`

hasHubInstanceAction

setHubInstanceAction

Optional. The execution information for the plugin instance action done corresponding to an API hub instance.

Parameter
Name	Description
`var`	`ExecutionStatus`

Returns
Type	Description
`$this`

getActionId

Required. This should map to one of the action id specified in actions_config in the plugin.

Returns
Type	Description
`string`

setActionId

Required. This should map to one of the action id specified in actions_config in the plugin.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getState

Output only. The current state of the plugin action in the plugin instance.

Returns
Type	Description
`int`	Enum of type State.

setState

Output only. The current state of the plugin action in the plugin instance.

Parameter
Name	Description
`var`	`int` Enum of type State.

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCurationConfig

Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.

Returns
Type	Description
`CurationConfig\|null`

hasCurationConfig

clearCurationConfig

setCurationConfig

Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.

Parameter
Name	Description
`var`	`CurationConfig`

Returns
Type	Description
`$this`

getScheduleTimeZone

Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.

Returns
Type	Description
`string`

setScheduleTimeZone