API hub v1 API - Class PluginInstanceAction (1.1.0) 

public sealed class PluginInstanceAction : IMessage<PluginInstanceAction>, IEquatable<PluginInstanceAction>, IDeepCloneable<PluginInstanceAction>, IBufferMessage, IMessage

Reference documentation and code samples for the API hub v1 API class PluginInstanceAction.

PluginInstanceAction represents an action which can be executed in the plugin instance.

Inheritance

object > PluginInstanceAction

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

PluginInstanceAction()

public PluginInstanceAction()

PluginInstanceAction(PluginInstanceAction)

public PluginInstanceAction(PluginInstanceAction other)
Parameter
Name Description
other PluginInstanceAction

Properties

ActionId

public string ActionId { get; set; }

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.

Property Value
Type Description
string

ActionStatusCase

public PluginInstanceAction.ActionStatusOneofCase ActionStatusCase { get; }
Property Value
Type Description
PluginInstanceActionActionStatusOneofCase

CurationConfig

public CurationConfig CurationConfig { get; set; }

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

Property Value
Type Description
CurationConfig

HubInstanceAction

public ExecutionStatus HubInstanceAction { get; set; }

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

Property Value
Type Description
ExecutionStatus

ResourceConfig

public PluginInstanceAction.Types.ResourceConfig ResourceConfig { get; set; }

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.

Property Value
Type Description
PluginInstanceActionTypesResourceConfig

ScheduleCronExpression

public string ScheduleCronExpression { get; set; }

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.

Property Value
Type Description
string

ScheduleTimeZone

public string ScheduleTimeZone { get; set; }

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

Property Value
Type Description
string

ServiceAccount

public string ServiceAccount { get; set; }

Optional. The service account used to publish data. Note, the service account will only be accepted for non GCP plugins like OPDK.

Property Value
Type Description
string

State

public PluginInstanceAction.Types.State State { get; set; }

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

Property Value
Type Description
PluginInstanceActionTypesState