Class PluginInstanceAction (0.28.0) 

public final class PluginInstanceAction extends GeneratedMessageV3 implements PluginInstanceActionOrBuilder

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

Protobuf type google.cloud.apihub.v1.PluginInstanceAction

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PluginInstanceAction

Static Fields

ACTION_ID_FIELD_NUMBER

public static final int ACTION_ID_FIELD_NUMBER
Field Value
Type Description
int

CURATION_CONFIG_FIELD_NUMBER

public static final int CURATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

HUB_INSTANCE_ACTION_FIELD_NUMBER

public static final int HUB_INSTANCE_ACTION_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_CONFIG_FIELD_NUMBER

public static final int RESOURCE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_CRON_EXPRESSION_FIELD_NUMBER

public static final int SCHEDULE_CRON_EXPRESSION_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_TIME_ZONE_FIELD_NUMBER

public static final int SCHEDULE_TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PluginInstanceAction getDefaultInstance()
Returns
Type Description
PluginInstanceAction

getDescriptor()

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

newBuilder()

public static PluginInstanceAction.Builder newBuilder()
Returns
Type Description
PluginInstanceAction.Builder

newBuilder(PluginInstanceAction prototype)

public static PluginInstanceAction.Builder newBuilder(PluginInstanceAction prototype)
Parameter
Name Description
prototype PluginInstanceAction
Returns
Type Description
PluginInstanceAction.Builder

parseDelimitedFrom(InputStream input)

public static PluginInstanceAction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PluginInstanceAction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PluginInstanceAction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PluginInstanceAction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PluginInstanceAction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PluginInstanceAction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PluginInstanceAction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PluginInstanceAction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PluginInstanceAction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PluginInstanceAction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PluginInstanceAction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PluginInstanceAction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PluginInstanceAction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PluginInstanceAction> parser()
Returns
Type Description
Parser<PluginInstanceAction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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.

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

getParserForType()

public Parser<PluginInstanceAction> getParserForType()
Returns
Type Description
Parser<PluginInstanceAction>
Overrides

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.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PluginInstanceAction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PluginInstanceAction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException