Package com.google.cloud.workflows.v1
Class Workflow
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.workflows.v1.Workflow
- All Implemented Interfaces:
WorkflowOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Workflow
extends com.google.protobuf.GeneratedMessage
implements WorkflowOrBuilder
Workflow program to be executed by Workflows.Protobuf type
google.cloud.workflows.v1.Workflow- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classWorkflow program to be executed by Workflows.static enumDescribes the level of platform logging to apply to calls and call responses during workflow executions.static enumstatic enumDescribes the current state of workflow deployment.static final classDescribes an error related to the current state of the workflow.static interfaceNested 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 intstatic final intstatic final intstatic final intstatic 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 TypeMethodDescriptionbooleancontainsLabels(String key) Labels associated with this workflow.booleancontainsTags(String key) Optional.booleanOptional.booleangetAllKmsKeys(int index) Output only.com.google.protobuf.ByteStringgetAllKmsKeysBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.getAllKmsKeysVersions(int index) Output only.com.google.protobuf.ByteStringgetAllKmsKeysVersionsBytes(int index) Output only.intOutput only.com.google.protobuf.ProtocolStringListOutput only.Optional.intOptional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Optional.com.google.protobuf.ByteStringOptional.Output only.com.google.protobuf.ByteStringOutput only.static WorkflowDescription of the workflow provided by the user.com.google.protobuf.ByteStringDescription of the workflow provided by the user.static final com.google.protobuf.Descriptors.DescriptorOptional.intOptional.Deprecated.intLabels associated with this workflow.Labels associated with this workflow.getLabelsOrDefault(String key, String defaultValue) Labels associated with this workflow.getLabelsOrThrow(String key) Labels associated with this workflow.getName()The resource name of the workflow.com.google.protobuf.ByteStringThe resource name of the workflow.com.google.protobuf.Parser<Workflow>com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.com.google.protobuf.ByteStringOutput only.intThe service account associated with the latest workflow version.com.google.protobuf.ByteStringThe service account associated with the latest workflow version.Workflow code to be executed.com.google.protobuf.ByteStringWorkflow code to be executed.getState()Output only.Output only.Output only.intOutput only.getTags()Deprecated.intOptional.Optional.getTagsOrDefault(String key, String defaultValue) Optional.getTagsOrThrow(String key) Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Deprecated.intOptional.Optional.getUserEnvVarsOrDefault(String key, String defaultValue) Optional.Optional.booleanOutput only.inthashCode()booleanOutput only.booleanWorkflow code to be executed.booleanOutput only.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Workflow.Builderstatic Workflow.BuildernewBuilder(Workflow prototype) protected Workflow.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static WorkflowparseDelimitedFrom(InputStream input) static WorkflowparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkflowparseFrom(byte[] data) static WorkflowparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkflowparseFrom(com.google.protobuf.ByteString data) static WorkflowparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkflowparseFrom(com.google.protobuf.CodedInputStream input) static WorkflowparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkflowparseFrom(InputStream input) static WorkflowparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static WorkflowparseFrom(ByteBuffer data) static WorkflowparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Workflow>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, 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
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER- See Also:
-
REVISION_ID_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
REVISION_CREATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER- See Also:
-
SOURCE_CONTENTS_FIELD_NUMBER
public static final int SOURCE_CONTENTS_FIELD_NUMBER- See Also:
-
CRYPTO_KEY_NAME_FIELD_NUMBER
public static final int CRYPTO_KEY_NAME_FIELD_NUMBER- See Also:
-
STATE_ERROR_FIELD_NUMBER
public static final int STATE_ERROR_FIELD_NUMBER- See Also:
-
CALL_LOG_LEVEL_FIELD_NUMBER
public static final int CALL_LOG_LEVEL_FIELD_NUMBER- See Also:
-
USER_ENV_VARS_FIELD_NUMBER
public static final int USER_ENV_VARS_FIELD_NUMBER- See Also:
-
EXECUTION_HISTORY_LEVEL_FIELD_NUMBER
public static final int EXECUTION_HISTORY_LEVEL_FIELD_NUMBER- See Also:
-
ALL_KMS_KEYS_FIELD_NUMBER
public static final int ALL_KMS_KEYS_FIELD_NUMBER- See Also:
-
ALL_KMS_KEYS_VERSIONS_FIELD_NUMBER
public static final int ALL_KMS_KEYS_VERSIONS_FIELD_NUMBER- See Also:
-
CRYPTO_KEY_VERSION_FIELD_NUMBER
public static final int CRYPTO_KEY_VERSION_FIELD_NUMBER- See Also:
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getSourceCodeCase
- Specified by:
getSourceCodeCasein interfaceWorkflowOrBuilder
-
getName
The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.string name = 1;- Specified by:
getNamein interfaceWorkflowOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.string name = 1;- Specified by:
getNameBytesin interfaceWorkflowOrBuilder- Returns:
- The bytes for name.
-
getDescription
Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
string description = 2;- Specified by:
getDescriptionin interfaceWorkflowOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
string description = 2;- Specified by:
getDescriptionBytesin interfaceWorkflowOrBuilder- Returns:
- The bytes for description.
-
getStateValue
public int getStateValue()Output only. State of the workflow deployment.
.google.cloud.workflows.v1.Workflow.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein interfaceWorkflowOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
getState
Output only. State of the workflow deployment.
.google.cloud.workflows.v1.Workflow.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceWorkflowOrBuilder- Returns:
- The state.
-
getRevisionId
Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - [Service account][google.cloud.workflows.v1.Workflow.service_account] - [Workflow code to be executed][google.cloud.workflows.v1.Workflow.source_contents] The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
string revision_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRevisionIdin interfaceWorkflowOrBuilder- Returns:
- The revisionId.
-
getRevisionIdBytes
public com.google.protobuf.ByteString getRevisionIdBytes()Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - [Service account][google.cloud.workflows.v1.Workflow.service_account] - [Workflow code to be executed][google.cloud.workflows.v1.Workflow.source_contents] The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
string revision_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRevisionIdBytesin interfaceWorkflowOrBuilder- Returns:
- The bytes for revisionId.
-
hasCreateTime
public boolean hasCreateTime()Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceWorkflowOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceWorkflowOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceWorkflowOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceWorkflowOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceWorkflowOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceWorkflowOrBuilder
-
hasRevisionCreateTime
public boolean hasRevisionCreateTime()Output only. The timestamp for the latest revision of the workflow's creation.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasRevisionCreateTimein interfaceWorkflowOrBuilder- Returns:
- Whether the revisionCreateTime field is set.
-
getRevisionCreateTime
public com.google.protobuf.Timestamp getRevisionCreateTime()Output only. The timestamp for the latest revision of the workflow's creation.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRevisionCreateTimein interfaceWorkflowOrBuilder- Returns:
- The revisionCreateTime.
-
getRevisionCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getRevisionCreateTimeOrBuilder()Output only. The timestamp for the latest revision of the workflow's creation.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getRevisionCreateTimeOrBuilderin interfaceWorkflowOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:WorkflowOrBuilderLabels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
map<string, string> labels = 8;- Specified by:
getLabelsCountin interfaceWorkflowOrBuilder
-
containsLabels
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
map<string, string> labels = 8;- Specified by:
containsLabelsin interfaceWorkflowOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceWorkflowOrBuilder
-
getLabelsMap
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
map<string, string> labels = 8;- Specified by:
getLabelsMapin interfaceWorkflowOrBuilder
-
getLabelsOrDefault
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
map<string, string> labels = 8;- Specified by:
getLabelsOrDefaultin interfaceWorkflowOrBuilder
-
getLabelsOrThrow
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
map<string, string> labels = 8;- Specified by:
getLabelsOrThrowin interfaceWorkflowOrBuilder
-
getServiceAccount
The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.string service_account = 9;- Specified by:
getServiceAccountin interfaceWorkflowOrBuilder- Returns:
- The serviceAccount.
-
getServiceAccountBytes
public com.google.protobuf.ByteString getServiceAccountBytes()The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.string service_account = 9;- Specified by:
getServiceAccountBytesin interfaceWorkflowOrBuilder- Returns:
- The bytes for serviceAccount.
-
hasSourceContents
public boolean hasSourceContents()Workflow code to be executed. The size limit is 128KB.
string source_contents = 10;- Specified by:
hasSourceContentsin interfaceWorkflowOrBuilder- Returns:
- Whether the sourceContents field is set.
-
getSourceContents
Workflow code to be executed. The size limit is 128KB.
string source_contents = 10;- Specified by:
getSourceContentsin interfaceWorkflowOrBuilder- Returns:
- The sourceContents.
-
getSourceContentsBytes
public com.google.protobuf.ByteString getSourceContentsBytes()Workflow code to be executed. The size limit is 128KB.
string source_contents = 10;- Specified by:
getSourceContentsBytesin interfaceWorkflowOrBuilder- Returns:
- The bytes for sourceContents.
-
getCryptoKeyName
Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getCryptoKeyNamein interfaceWorkflowOrBuilder- Returns:
- The cryptoKeyName.
-
getCryptoKeyNameBytes
public com.google.protobuf.ByteString getCryptoKeyNameBytes()Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Specified by:
getCryptoKeyNameBytesin interfaceWorkflowOrBuilder- Returns:
- The bytes for cryptoKeyName.
-
hasStateError
public boolean hasStateError()Output only. Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
.google.cloud.workflows.v1.Workflow.StateError state_error = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasStateErrorin interfaceWorkflowOrBuilder- Returns:
- Whether the stateError field is set.
-
getStateError
Output only. Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
.google.cloud.workflows.v1.Workflow.StateError state_error = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateErrorin interfaceWorkflowOrBuilder- Returns:
- The stateError.
-
getStateErrorOrBuilder
Output only. Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
.google.cloud.workflows.v1.Workflow.StateError state_error = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateErrorOrBuilderin interfaceWorkflowOrBuilder
-
getCallLogLevelValue
public int getCallLogLevelValue()Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
.google.cloud.workflows.v1.Workflow.CallLogLevel call_log_level = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCallLogLevelValuein interfaceWorkflowOrBuilder- Returns:
- The enum numeric value on the wire for callLogLevel.
-
getCallLogLevel
Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
.google.cloud.workflows.v1.Workflow.CallLogLevel call_log_level = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getCallLogLevelin interfaceWorkflowOrBuilder- Returns:
- The callLogLevel.
-
getUserEnvVarsCount
public int getUserEnvVarsCount()Description copied from interface:WorkflowOrBuilderOptional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".
map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getUserEnvVarsCountin interfaceWorkflowOrBuilder
-
containsUserEnvVars
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".
map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
containsUserEnvVarsin interfaceWorkflowOrBuilder
-
getUserEnvVars
Deprecated.UsegetUserEnvVarsMap()instead.- Specified by:
getUserEnvVarsin interfaceWorkflowOrBuilder
-
getUserEnvVarsMap
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".
map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getUserEnvVarsMapin interfaceWorkflowOrBuilder
-
getUserEnvVarsOrDefault
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".
map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getUserEnvVarsOrDefaultin interfaceWorkflowOrBuilder
-
getUserEnvVarsOrThrow
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 4KiB. Keys cannot be empty strings and cannot start with "GOOGLE" or "WORKFLOWS".
map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getUserEnvVarsOrThrowin interfaceWorkflowOrBuilder
-
getExecutionHistoryLevelValue
public int getExecutionHistoryLevelValue()Optional. Describes the execution history level to apply to this workflow.
.google.cloud.workflows.v1.ExecutionHistoryLevel execution_history_level = 15 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getExecutionHistoryLevelValuein interfaceWorkflowOrBuilder- Returns:
- The enum numeric value on the wire for executionHistoryLevel.
-
getExecutionHistoryLevel
Optional. Describes the execution history level to apply to this workflow.
.google.cloud.workflows.v1.ExecutionHistoryLevel execution_history_level = 15 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getExecutionHistoryLevelin interfaceWorkflowOrBuilder- Returns:
- The executionHistoryLevel.
-
getAllKmsKeysList
public com.google.protobuf.ProtocolStringList getAllKmsKeysList()Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysListin interfaceWorkflowOrBuilder- Returns:
- A list containing the allKmsKeys.
-
getAllKmsKeysCount
public int getAllKmsKeysCount()Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysCountin interfaceWorkflowOrBuilder- Returns:
- The count of allKmsKeys.
-
getAllKmsKeys
Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysin interfaceWorkflowOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The allKmsKeys at the given index.
-
getAllKmsKeysBytes
public com.google.protobuf.ByteString getAllKmsKeysBytes(int index) Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys = 16 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysBytesin interfaceWorkflowOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the allKmsKeys at the given index.
-
getAllKmsKeysVersionsList
public com.google.protobuf.ProtocolStringList getAllKmsKeysVersionsList()Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys_versions = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysVersionsListin interfaceWorkflowOrBuilder- Returns:
- A list containing the allKmsKeysVersions.
-
getAllKmsKeysVersionsCount
public int getAllKmsKeysVersionsCount()Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys_versions = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysVersionsCountin interfaceWorkflowOrBuilder- Returns:
- The count of allKmsKeysVersions.
-
getAllKmsKeysVersions
Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys_versions = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysVersionsin interfaceWorkflowOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The allKmsKeysVersions at the given index.
-
getAllKmsKeysVersionsBytes
public com.google.protobuf.ByteString getAllKmsKeysVersionsBytes(int index) Output only. A list of all KMS crypto key versions used to encrypt or decrypt the data associated with the workflow.
repeated string all_kms_keys_versions = 17 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getAllKmsKeysVersionsBytesin interfaceWorkflowOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the allKmsKeysVersions at the given index.
-
getCryptoKeyVersion
Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}string crypto_key_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getCryptoKeyVersionin interfaceWorkflowOrBuilder- Returns:
- The cryptoKeyVersion.
-
getCryptoKeyVersionBytes
public com.google.protobuf.ByteString getCryptoKeyVersionBytes()Output only. The resource name of a KMS crypto key version used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}string crypto_key_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }- Specified by:
getCryptoKeyVersionBytesin interfaceWorkflowOrBuilder- Returns:
- The bytes for cryptoKeyVersion.
-
getTagsCount
public int getTagsCount()Description copied from interface:WorkflowOrBuilderOptional. Input only. Immutable. Tags associated with this workflow.
map<string, string> tags = 19 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsCountin interfaceWorkflowOrBuilder
-
containsTags
Optional. Input only. Immutable. Tags associated with this workflow.
map<string, string> tags = 19 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
containsTagsin interfaceWorkflowOrBuilder
-
getTags
Deprecated.UsegetTagsMap()instead.- Specified by:
getTagsin interfaceWorkflowOrBuilder
-
getTagsMap
Optional. Input only. Immutable. Tags associated with this workflow.
map<string, string> tags = 19 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsMapin interfaceWorkflowOrBuilder
-
getTagsOrDefault
Optional. Input only. Immutable. Tags associated with this workflow.
map<string, string> tags = 19 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsOrDefaultin interfaceWorkflowOrBuilder
-
getTagsOrThrow
Optional. Input only. Immutable. Tags associated with this workflow.
map<string, string> tags = 19 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];- Specified by:
getTagsOrThrowin interfaceWorkflowOrBuilder
-
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 Workflow parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Workflow parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Workflow parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Workflow parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Workflow parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Workflow parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Workflow parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Workflow parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Workflow 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 Workflow.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
-