Class PluginInstanceAction.Builder (0.28.0)

public static final class PluginInstanceAction.Builder extends GeneratedMessageV3.Builder<PluginInstanceAction.Builder> implements PluginInstanceActionOrBuilder

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

Protobuf type google.cloud.apihub.v1.PluginInstanceAction

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PluginInstanceAction.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PluginInstanceAction.Builder
Overrides

build()

public PluginInstanceAction build()
Returns
Type Description
PluginInstanceAction

buildPartial()

public PluginInstanceAction buildPartial()
Returns
Type Description
PluginInstanceAction

clear()

public PluginInstanceAction.Builder clear()
Returns
Type Description
PluginInstanceAction.Builder
Overrides

clearActionId()

public PluginInstanceAction.Builder clearActionId()

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
PluginInstanceAction.Builder

This builder for chaining.

clearActionStatus()

public PluginInstanceAction.Builder clearActionStatus()
Returns
Type Description
PluginInstanceAction.Builder

clearCurationConfig()

public PluginInstanceAction.Builder clearCurationConfig()

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
PluginInstanceAction.Builder

clearField(Descriptors.FieldDescriptor field)

public PluginInstanceAction.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PluginInstanceAction.Builder
Overrides

clearHubInstanceAction()

public PluginInstanceAction.Builder clearHubInstanceAction()

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
PluginInstanceAction.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PluginInstanceAction.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PluginInstanceAction.Builder
Overrides

clearResourceConfig()

public PluginInstanceAction.Builder clearResourceConfig()

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.Builder

clearScheduleCronExpression()

public PluginInstanceAction.Builder clearScheduleCronExpression()

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
PluginInstanceAction.Builder

This builder for chaining.

clearScheduleTimeZone()

public PluginInstanceAction.Builder clearScheduleTimeZone()

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
PluginInstanceAction.Builder

This builder for chaining.

clearServiceAccount()

public PluginInstanceAction.Builder clearServiceAccount()

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
PluginInstanceAction.Builder

This builder for chaining.

clearState()

public PluginInstanceAction.Builder clearState()

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.Builder

This builder for chaining.

clone()

public PluginInstanceAction.Builder clone()
Returns
Type Description
PluginInstanceAction.Builder
Overrides

getActionId()

public 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 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 PluginInstanceAction.ActionStatusCase getActionStatusCase()
Returns
Type Description
PluginInstanceAction.ActionStatusCase

getCurationConfig()

public 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.

getCurationConfigBuilder()

public CurationConfig.Builder getCurationConfigBuilder()

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.Builder

getCurationConfigOrBuilder()

public 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

getDefaultInstanceForType()

public PluginInstanceAction getDefaultInstanceForType()
Returns
Type Description
PluginInstanceAction

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHubInstanceAction()

public 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.

getHubInstanceActionBuilder()

public ExecutionStatus.Builder getHubInstanceActionBuilder()

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.Builder

getHubInstanceActionOrBuilder()

public 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 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.

getResourceConfigBuilder()

public PluginInstanceAction.ResourceConfig.Builder getResourceConfigBuilder()

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.Builder

getResourceConfigOrBuilder()

public 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 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 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 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 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 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 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 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCurationConfig(CurationConfig value)

public PluginInstanceAction.Builder mergeCurationConfig(CurationConfig value)

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

Parameter
Name Description
value CurationConfig
Returns
Type Description
PluginInstanceAction.Builder

mergeFrom(PluginInstanceAction other)

public PluginInstanceAction.Builder mergeFrom(PluginInstanceAction other)
Parameter
Name Description
other PluginInstanceAction
Returns
Type Description
PluginInstanceAction.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PluginInstanceAction.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PluginInstanceAction.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PluginInstanceAction.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PluginInstanceAction.Builder
Overrides

mergeHubInstanceAction(ExecutionStatus value)

public PluginInstanceAction.Builder mergeHubInstanceAction(ExecutionStatus value)

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

Parameter
Name Description
value ExecutionStatus
Returns
Type Description
PluginInstanceAction.Builder

mergeResourceConfig(PluginInstanceAction.ResourceConfig value)

public PluginInstanceAction.Builder mergeResourceConfig(PluginInstanceAction.ResourceConfig value)

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

Parameter
Name Description
value PluginInstanceAction.ResourceConfig
Returns
Type Description
PluginInstanceAction.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PluginInstanceAction.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PluginInstanceAction.Builder
Overrides

setActionId(String value)

public PluginInstanceAction.Builder setActionId(String value)

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

Parameter
Name Description
value String

The actionId to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setActionIdBytes(ByteString value)

public PluginInstanceAction.Builder setActionIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for actionId to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setCurationConfig(CurationConfig value)

public PluginInstanceAction.Builder setCurationConfig(CurationConfig value)

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

Parameter
Name Description
value CurationConfig
Returns
Type Description
PluginInstanceAction.Builder

setCurationConfig(CurationConfig.Builder builderForValue)

public PluginInstanceAction.Builder setCurationConfig(CurationConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue CurationConfig.Builder
Returns
Type Description
PluginInstanceAction.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PluginInstanceAction.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PluginInstanceAction.Builder
Overrides

setHubInstanceAction(ExecutionStatus value)

public PluginInstanceAction.Builder setHubInstanceAction(ExecutionStatus value)

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

Parameter
Name Description
value ExecutionStatus
Returns
Type Description
PluginInstanceAction.Builder

setHubInstanceAction(ExecutionStatus.Builder builderForValue)

public PluginInstanceAction.Builder setHubInstanceAction(ExecutionStatus.Builder builderForValue)

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

Parameter
Name Description
builderForValue ExecutionStatus.Builder
Returns
Type Description
PluginInstanceAction.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PluginInstanceAction.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PluginInstanceAction.Builder
Overrides

setResourceConfig(PluginInstanceAction.ResourceConfig value)

public PluginInstanceAction.Builder setResourceConfig(PluginInstanceAction.ResourceConfig value)

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

Parameter
Name Description
value PluginInstanceAction.ResourceConfig
Returns
Type Description
PluginInstanceAction.Builder

setResourceConfig(PluginInstanceAction.ResourceConfig.Builder builderForValue)

public PluginInstanceAction.Builder setResourceConfig(PluginInstanceAction.ResourceConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue PluginInstanceAction.ResourceConfig.Builder
Returns
Type Description
PluginInstanceAction.Builder

setScheduleCronExpression(String value)

public PluginInstanceAction.Builder setScheduleCronExpression(String value)

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

Parameter
Name Description
value String

The scheduleCronExpression to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setScheduleCronExpressionBytes(ByteString value)

public PluginInstanceAction.Builder setScheduleCronExpressionBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for scheduleCronExpression to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setScheduleTimeZone(String value)

public PluginInstanceAction.Builder setScheduleTimeZone(String value)

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

Parameter
Name Description
value String

The scheduleTimeZone to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setScheduleTimeZoneBytes(ByteString value)

public PluginInstanceAction.Builder setScheduleTimeZoneBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for scheduleTimeZone to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setServiceAccount(String value)

public PluginInstanceAction.Builder setServiceAccount(String value)

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

Parameter
Name Description
value String

The serviceAccount to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public PluginInstanceAction.Builder setServiceAccountBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for serviceAccount to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setState(PluginInstanceAction.State value)

public PluginInstanceAction.Builder setState(PluginInstanceAction.State value)

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

Parameter
Name Description
value PluginInstanceAction.State

The state to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setStateValue(int value)

public PluginInstanceAction.Builder setStateValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
PluginInstanceAction.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final PluginInstanceAction.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PluginInstanceAction.Builder
Overrides