Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Interface PluginInstanceActionOrBuilder (0.28.0)

public interface PluginInstanceActionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActionId()

public abstract String getActionId()

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

string action_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The actionId.

getActionIdBytes()

public abstract ByteString getActionIdBytes()

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

string action_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for actionId.

getActionStatusCase()

public abstract PluginInstanceAction.ActionStatusCase getActionStatusCase()

Returns
Type	Description
`PluginInstanceAction.ActionStatusCase`

getCurationConfig()

public abstract 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
Type	Description
`CurationConfig`	The curationConfig.

getCurationConfigOrBuilder()

public abstract 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];

Returns
Type	Description
`CurationConfigOrBuilder`

getHubInstanceAction()

public abstract 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
Type	Description
`ExecutionStatus`	The hubInstanceAction.

getHubInstanceActionOrBuilder()

public abstract 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];

Returns
Type	Description
`ExecutionStatusOrBuilder`

getResourceConfig()

public abstract PluginInstanceAction.ResourceConfig 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
Type	Description
`PluginInstanceAction.ResourceConfig`	The resourceConfig.

getResourceConfigOrBuilder()

public abstract 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];

Returns
Type	Description
`PluginInstanceAction.ResourceConfigOrBuilder`

getScheduleCronExpression()

public abstract 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
Type	Description
`String`	The scheduleCronExpression.

getScheduleCronExpressionBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for scheduleCronExpression.

getScheduleTimeZone()

public abstract 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
Type	Description
`String`	The scheduleTimeZone.

getScheduleTimeZoneBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for scheduleTimeZone.

getServiceAccount()

public abstract 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
Type	Description
`String`	The serviceAccount.

getServiceAccountBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for serviceAccount.

getState()

public abstract PluginInstanceAction.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
Type	Description
`PluginInstanceAction.State`	The state.

getStateValue()

public abstract 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
Type	Description
`int`	The enum numeric value on the wire for state.

hasCurationConfig()

public abstract 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
Type	Description
`boolean`	Whether the curationConfig field is set.

hasHubInstanceAction()

public abstract 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
Type	Description
`boolean`	Whether the hubInstanceAction field is set.

hasResourceConfig()

public abstract 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
Type	Description
`boolean`	Whether the resourceConfig field is set.