Class Workflow (2.62.0) 

public final class Workflow extends GeneratedMessageV3 implements WorkflowOrBuilder

Workflow program to be executed by Workflows.

Protobuf type google.cloud.workflows.v1.Workflow

Inheritance

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

Implements

WorkflowOrBuilder

Static Fields

ALL_KMS_KEYS_FIELD_NUMBER

public static final int ALL_KMS_KEYS_FIELD_NUMBER
Field Value
Type Description
int

ALL_KMS_KEYS_VERSIONS_FIELD_NUMBER

public static final int ALL_KMS_KEYS_VERSIONS_FIELD_NUMBER
Field Value
Type Description
int

CALL_LOG_LEVEL_FIELD_NUMBER

public static final int CALL_LOG_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CRYPTO_KEY_NAME_FIELD_NUMBER

public static final int CRYPTO_KEY_NAME_FIELD_NUMBER
Field Value
Type Description
int

CRYPTO_KEY_VERSION_FIELD_NUMBER

public static final int CRYPTO_KEY_VERSION_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_HISTORY_LEVEL_FIELD_NUMBER

public static final int EXECUTION_HISTORY_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REVISION_CREATE_TIME_FIELD_NUMBER

public static final int REVISION_CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

REVISION_ID_FIELD_NUMBER

public static final int REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_CONTENTS_FIELD_NUMBER

public static final int SOURCE_CONTENTS_FIELD_NUMBER
Field Value
Type Description
int

STATE_ERROR_FIELD_NUMBER

public static final int STATE_ERROR_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

USER_ENV_VARS_FIELD_NUMBER

public static final int USER_ENV_VARS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Workflow getDefaultInstance()
Returns
Type Description
Workflow

getDescriptor()

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

newBuilder()

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

newBuilder(Workflow prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsTags(String key)

public boolean containsTags(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

containsUserEnvVars(String key)

public boolean containsUserEnvVars(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllKmsKeys(int index)

public String getAllKmsKeys(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) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The allKmsKeys at the given index.

getAllKmsKeysBytes(int index)

public 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) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the allKmsKeys at the given index.

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) = { ... }

Returns
Type Description
int

The count of allKmsKeys.

getAllKmsKeysList()

public 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) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the allKmsKeys.

getAllKmsKeysVersions(int index)

public String getAllKmsKeysVersions(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) = { ... }

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The allKmsKeysVersions at the given index.

getAllKmsKeysVersionsBytes(int index)

public 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) = { ... }

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the allKmsKeysVersions at the given index.

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) = { ... }

Returns
Type Description
int

The count of allKmsKeysVersions.

getAllKmsKeysVersionsList()

public 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) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the allKmsKeysVersions.

getCallLogLevel()

public Workflow.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];

Returns
Type Description
Workflow.CallLogLevel

The callLogLevel.

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

Returns
Type Description
int

The enum numeric value on the wire for callLogLevel.

getCreateTime()

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getCryptoKeyName()

public String 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) = { ... }

Returns
Type Description
String

The cryptoKeyName.

getCryptoKeyNameBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for cryptoKeyName.

getCryptoKeyVersion()

public String 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) = { ... }

Returns
Type Description
String

The cryptoKeyVersion.

getCryptoKeyVersionBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for cryptoKeyVersion.

getDefaultInstanceForType()

public Workflow getDefaultInstanceForType()
Returns
Type Description
Workflow

getDescription()

public String 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;

Returns
Type Description
String

The description.

getDescriptionBytes()

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

Returns
Type Description
ByteString

The bytes for description.

getExecutionHistoryLevel()

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

Returns
Type Description
ExecutionHistoryLevel

The executionHistoryLevel.

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

Returns
Type Description
int

The enum numeric value on the wire for executionHistoryLevel.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> 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;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String 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;

Returns
Type Description
String

The name.

getNameBytes()

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getRevisionCreateTime()

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

Returns
Type Description
Timestamp

The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getRevisionId()

public String 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
  • Workflow code to be executed

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

Returns
Type Description
String

The revisionId.

getRevisionIdBytes()

public 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
  • Workflow code to be executed

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

Returns
Type Description
ByteString

The bytes for revisionId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAccount()

public String 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;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

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

Returns
Type Description
ByteString

The bytes for serviceAccount.

getSourceCodeCase()

public Workflow.SourceCodeCase getSourceCodeCase()
Returns
Type Description
Workflow.SourceCodeCase

getSourceContents()

public String getSourceContents()

Workflow code to be executed. The size limit is 128KB.

string source_contents = 10;

Returns
Type Description
String

The sourceContents.

getSourceContentsBytes()

public ByteString getSourceContentsBytes()

Workflow code to be executed. The size limit is 128KB.

string source_contents = 10;

Returns
Type Description
ByteString

The bytes for sourceContents.

getState()

public Workflow.State getState()

Output only. State of the workflow deployment.

.google.cloud.workflows.v1.Workflow.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Workflow.State

The state.

getStateError()

public Workflow.StateError 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];

Returns
Type Description
Workflow.StateError

The stateError.

getStateErrorOrBuilder()

public Workflow.StateErrorOrBuilder 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];

Returns
Type Description
Workflow.StateErrorOrBuilder

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getTags() (deprecated)

public Map<String,String> getTags()

Use #getTagsMap() instead.

Returns
Type Description
Map<String,String>

getTagsCount()

public int getTagsCount()

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

Returns
Type Description
int

getTagsMap()

public Map<String,String> 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];

Returns
Type Description
Map<String,String>

getTagsOrDefault(String key, String defaultValue)

public String getTagsOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getTagsOrThrow(String key)

public String getTagsOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getUpdateTime()

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getUserEnvVars() (deprecated)

public Map<String,String> getUserEnvVars()

Use #getUserEnvVarsMap() instead.

Returns
Type Description
Map<String,String>

getUserEnvVarsCount()

public int getUserEnvVarsCount()

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

Returns
Type Description
int

getUserEnvVarsMap()

public Map<String,String> 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];

Returns
Type Description
Map<String,String>

getUserEnvVarsOrDefault(String key, String defaultValue)

public String getUserEnvVarsOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getUserEnvVarsOrThrow(String key)

public String getUserEnvVarsOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

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

Returns
Type Description
boolean

Whether the createTime field is set.

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

Returns
Type Description
boolean

Whether the revisionCreateTime field is set.

hasSourceContents()

public boolean hasSourceContents()

Workflow code to be executed. The size limit is 128KB.

string source_contents = 10;

Returns
Type Description
boolean

Whether the sourceContents field is set.

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

Returns
Type Description
boolean

Whether the stateError field is set.

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

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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