Package com.google.cloud.apihub.v1
Class PluginInstanceAction
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.apihub.v1.PluginInstanceAction
- All Implemented Interfaces:
PluginInstanceActionOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class PluginInstanceAction
extends com.google.protobuf.GeneratedMessage
implements PluginInstanceActionOrBuilder
PluginInstanceAction represents an action which can be executed in the plugin instance.Protobuf type
google.cloud.apihub.v1.PluginInstanceAction- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumstatic final classPluginInstanceAction represents an action which can be executed in the plugin instance.static final classThe configuration of resources created for a given plugin instance action.static interfacestatic enumState represents the state of the plugin instance action.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanRequired.com.google.protobuf.ByteStringRequired.Optional.Optional.static PluginInstanceActionstatic final com.google.protobuf.Descriptors.DescriptorOptional.Optional.com.google.protobuf.Parser<PluginInstanceAction>Output only.Output only.Optional.com.google.protobuf.ByteStringOptional.Optional.com.google.protobuf.ByteStringOptional.intOptional.com.google.protobuf.ByteStringOptional.getState()Output only.intOutput only.booleanOptional.inthashCode()booleanOptional.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic PluginInstanceAction.Builderstatic PluginInstanceAction.BuildernewBuilder(PluginInstanceAction prototype) protected PluginInstanceAction.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static PluginInstanceActionparseDelimitedFrom(InputStream input) static PluginInstanceActionparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginInstanceActionparseFrom(byte[] data) static PluginInstanceActionparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginInstanceActionparseFrom(com.google.protobuf.ByteString data) static PluginInstanceActionparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginInstanceActionparseFrom(com.google.protobuf.CodedInputStream input) static PluginInstanceActionparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginInstanceActionparseFrom(InputStream input) static PluginInstanceActionparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PluginInstanceActionparseFrom(ByteBuffer data) static PluginInstanceActionparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<PluginInstanceAction>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
HUB_INSTANCE_ACTION_FIELD_NUMBER
public static final int HUB_INSTANCE_ACTION_FIELD_NUMBER- See Also:
-
ACTION_ID_FIELD_NUMBER
public static final int ACTION_ID_FIELD_NUMBER- See Also:
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER- See Also:
-
SCHEDULE_CRON_EXPRESSION_FIELD_NUMBER
public static final int SCHEDULE_CRON_EXPRESSION_FIELD_NUMBER- See Also:
-
CURATION_CONFIG_FIELD_NUMBER
public static final int CURATION_CONFIG_FIELD_NUMBER- See Also:
-
SCHEDULE_TIME_ZONE_FIELD_NUMBER
public static final int SCHEDULE_TIME_ZONE_FIELD_NUMBER- See Also:
-
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER- See Also:
-
RESOURCE_CONFIG_FIELD_NUMBER
public static final int RESOURCE_CONFIG_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getActionStatusCase
- Specified by:
getActionStatusCasein interfacePluginInstanceActionOrBuilder
-
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];- Specified by:
hasHubInstanceActionin interfacePluginInstanceActionOrBuilder- Returns:
- Whether the hubInstanceAction field is set.
-
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];- Specified by:
getHubInstanceActionin interfacePluginInstanceActionOrBuilder- Returns:
- The hubInstanceAction.
-
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];- Specified by:
getHubInstanceActionOrBuilderin interfacePluginInstanceActionOrBuilder
-
getActionId
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.
string action_id = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getActionIdin interfacePluginInstanceActionOrBuilder- Returns:
- The actionId.
-
getActionIdBytes
public com.google.protobuf.ByteString getActionIdBytes()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.
string action_id = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getActionIdBytesin interfacePluginInstanceActionOrBuilder- Returns:
- The bytes for actionId.
-
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];- Specified by:
getStateValuein interfacePluginInstanceActionOrBuilder- Returns:
- The enum numeric value on the wire for 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];- Specified by:
getStatein interfacePluginInstanceActionOrBuilder- Returns:
- The state.
-
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];- Specified by:
getScheduleCronExpressionin interfacePluginInstanceActionOrBuilder- Returns:
- The scheduleCronExpression.
-
getScheduleCronExpressionBytes
public com.google.protobuf.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];- Specified by:
getScheduleCronExpressionBytesin interfacePluginInstanceActionOrBuilder- Returns:
- The bytes for scheduleCronExpression.
-
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];- Specified by:
hasCurationConfigin interfacePluginInstanceActionOrBuilder- Returns:
- Whether the curationConfig field is set.
-
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];- Specified by:
getCurationConfigin interfacePluginInstanceActionOrBuilder- Returns:
- The curationConfig.
-
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];- Specified by:
getCurationConfigOrBuilderin interfacePluginInstanceActionOrBuilder
-
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];- Specified by:
getScheduleTimeZonein interfacePluginInstanceActionOrBuilder- Returns:
- The scheduleTimeZone.
-
getScheduleTimeZoneBytes
public com.google.protobuf.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];- Specified by:
getScheduleTimeZoneBytesin interfacePluginInstanceActionOrBuilder- Returns:
- The bytes for scheduleTimeZone.
-
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];- Specified by:
getServiceAccountin interfacePluginInstanceActionOrBuilder- Returns:
- The serviceAccount.
-
getServiceAccountBytes
public com.google.protobuf.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];- Specified by:
getServiceAccountBytesin interfacePluginInstanceActionOrBuilder- Returns:
- The bytes for serviceAccount.
-
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];- Specified by:
hasResourceConfigin interfacePluginInstanceActionOrBuilder- Returns:
- Whether the resourceConfig field is set.
-
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];- Specified by:
getResourceConfigin interfacePluginInstanceActionOrBuilder- Returns:
- The resourceConfig.
-
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];- Specified by:
getResourceConfigOrBuilderin interfacePluginInstanceActionOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static PluginInstanceAction parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PluginInstanceAction parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PluginInstanceAction parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PluginInstanceAction parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PluginInstanceAction parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PluginInstanceAction parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static PluginInstanceAction parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static PluginInstanceAction parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static PluginInstanceAction parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static PluginInstanceAction parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected PluginInstanceAction.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-