Class Workflow.Builder (2.34.0)

public static final class Workflow.Builder extends GeneratedMessageV3.Builder<Workflow.Builder> implements WorkflowOrBuilder

Workflow program to be executed by Workflows.

Protobuf type google.cloud.workflows.v1.Workflow

Inheritance

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

Implements

WorkflowOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Workflow.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Workflow build()

Returns
Type	Description
`Workflow`

buildPartial()

public Workflow buildPartial()

Returns
Type	Description
`Workflow`

clear()

public Workflow.Builder clear()

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCallLogLevel()

public Workflow.Builder clearCallLogLevel()

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.Builder`	This builder for chaining.

clearCreateTime()

public Workflow.Builder clearCreateTime()

Output only. The timestamp for when the workflow was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Workflow.Builder`

clearCryptoKeyName()

public Workflow.Builder clearCryptoKeyName()

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
`Workflow.Builder`	This builder for chaining.

clearDescription()

public Workflow.Builder clearDescription()

Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

string description = 2;

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Workflow.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLabels()

public Workflow.Builder clearLabels()

Returns
Type	Description
`Workflow.Builder`

clearName()

public Workflow.Builder clearName()

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}

string name = 1;

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Workflow.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRevisionCreateTime()

public Workflow.Builder clearRevisionCreateTime()

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

clearRevisionId()

public Workflow.Builder clearRevisionId()

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
`Workflow.Builder`	This builder for chaining.

clearServiceAccount()

public Workflow.Builder clearServiceAccount()

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
`Workflow.Builder`	This builder for chaining.

clearSourceCode()

public Workflow.Builder clearSourceCode()

Returns
Type	Description
`Workflow.Builder`

clearSourceContents()

public Workflow.Builder clearSourceContents()

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

string source_contents = 10;

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

clearState()

public Workflow.Builder clearState()

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.Builder`	This builder for chaining.

clearStateError()

public Workflow.Builder clearStateError()

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

clearUpdateTime()

public Workflow.Builder clearUpdateTime()

Output only. The timestamp for when the workflow was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Workflow.Builder`

clearUserEnvVars()

public Workflow.Builder clearUserEnvVars()

Returns
Type	Description
`Workflow.Builder`

clone()

public Workflow.Builder clone()

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

map<string, string> labels = 8;

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 40KiB. 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`

getCallLogLevel()

public Workflow.CallLogLevel getCallLogLevel()

.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()

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

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The timestamp for when the workflow was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Builder`

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp for when the workflow was created.

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

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.

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.

string description = 2;

Returns
Type	Description
`ByteString`	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public int getLabelsCount()

map<string, string> labels = 8;

Returns
Type	Description
`int`

getLabelsMap()

public Map<String,String> getLabelsMap()

map<string, string> labels = 8;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

map<string, string> labels = 8;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

map<string, string> labels = 8;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getMutableUserEnvVars() (deprecated)

public Map<String,String> getMutableUserEnvVars()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,String>`

getName()

public String getName()

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}

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}

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

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.

getRevisionCreateTimeBuilder()

public Timestamp.Builder getRevisionCreateTimeBuilder()

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

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.

getServiceAccount()

public String getServiceAccount()

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()

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.

getStateErrorBuilder()

public Workflow.StateError.Builder getStateErrorBuilder()

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

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.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp for when the workflow was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The timestamp for when the workflow was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Builder`

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp for when the workflow was last updated.

.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()

map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getUserEnvVarsMap()

public Map<String,String> getUserEnvVarsMap()

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)

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)

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.

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

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public Workflow.Builder mergeCreateTime(Timestamp value)

Output only. The timestamp for when the workflow was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Workflow.Builder`

mergeFrom(Workflow other)

public Workflow.Builder mergeFrom(Workflow other)

Parameter
Name	Description
`other`	`Workflow`

Returns
Type	Description
`Workflow.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Workflow.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Workflow.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Workflow.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Workflow.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRevisionCreateTime(Timestamp value)

public Workflow.Builder mergeRevisionCreateTime(Timestamp value)

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Workflow.Builder`

mergeStateError(Workflow.StateError value)

public Workflow.Builder mergeStateError(Workflow.StateError value)

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

Parameter
Name	Description
`value`	`Workflow.StateError`

Returns
Type	Description
`Workflow.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Workflow.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Workflow.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp for when the workflow was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Workflow.Builder`

putAllLabels(Map<String,String> values)

public Workflow.Builder putAllLabels(Map<String,String> values)

map<string, string> labels = 8;

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`Workflow.Builder`

putAllUserEnvVars(Map<String,String> values)

public Workflow.Builder putAllUserEnvVars(Map<String,String> values)

map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`values`	`Map<String,String>`

Returns
Type	Description
`Workflow.Builder`

putLabels(String key, String value)

public Workflow.Builder putLabels(String key, String value)

map<string, string> labels = 8;

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`Workflow.Builder`

putUserEnvVars(String key, String value)

public Workflow.Builder putUserEnvVars(String key, String value)

map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`value`	`String`

Returns
Type	Description
`Workflow.Builder`

removeLabels(String key)

public Workflow.Builder removeLabels(String key)

map<string, string> labels = 8;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Workflow.Builder`

removeUserEnvVars(String key)

public Workflow.Builder removeUserEnvVars(String key)

map<string, string> user_env_vars = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Workflow.Builder`

setCallLogLevel(Workflow.CallLogLevel value)

public Workflow.Builder setCallLogLevel(Workflow.CallLogLevel value)

.google.cloud.workflows.v1.Workflow.CallLogLevel call_log_level = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`Workflow.CallLogLevel` The callLogLevel to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setCallLogLevelValue(int value)

public Workflow.Builder setCallLogLevelValue(int value)

.google.cloud.workflows.v1.Workflow.CallLogLevel call_log_level = 13 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for callLogLevel to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setCreateTime(Timestamp value)

public Workflow.Builder setCreateTime(Timestamp value)

Output only. The timestamp for when the workflow was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Workflow.Builder`

setCreateTime(Timestamp.Builder builderForValue)

public Workflow.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp for when the workflow was created.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Workflow.Builder`

setCryptoKeyName(String value)

public Workflow.Builder setCryptoKeyName(String value)

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

Parameter
Name	Description
`value`	`String` The cryptoKeyName to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setCryptoKeyNameBytes(ByteString value)

public Workflow.Builder setCryptoKeyNameBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for cryptoKeyName to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setDescription(String value)

public Workflow.Builder setDescription(String value)

Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

string description = 2;

Parameter
Name	Description
`value`	`String` The description to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setDescriptionBytes(ByteString value)

public Workflow.Builder setDescriptionBytes(ByteString value)

Description of the workflow provided by the user. Must be at most 1000 unicode characters long.

string description = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for description to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Workflow.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Workflow.Builder setName(String value)

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}

string name = 1;

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Workflow.Builder setNameBytes(ByteString value)

The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}

string name = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRevisionCreateTime(Timestamp value)

public Workflow.Builder setRevisionCreateTime(Timestamp value)

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

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Workflow.Builder`

setRevisionCreateTime(Timestamp.Builder builderForValue)

public Workflow.Builder setRevisionCreateTime(Timestamp.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Workflow.Builder`

setRevisionId(String value)

public Workflow.Builder setRevisionId(String value)

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

Parameter
Name	Description
`value`	`String` The revisionId to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setRevisionIdBytes(ByteString value)

public Workflow.Builder setRevisionIdBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for revisionId to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setServiceAccount(String value)

public Workflow.Builder setServiceAccount(String value)

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;

Parameter
Name	Description
`value`	`String` The serviceAccount to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setServiceAccountBytes(ByteString value)

public Workflow.Builder setServiceAccountBytes(ByteString value)

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;

Parameter
Name	Description
`value`	`ByteString` The bytes for serviceAccount to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setSourceContents(String value)

public Workflow.Builder setSourceContents(String value)

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

string source_contents = 10;

Parameter
Name	Description
`value`	`String` The sourceContents to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setSourceContentsBytes(ByteString value)

public Workflow.Builder setSourceContentsBytes(ByteString value)

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

string source_contents = 10;

Parameter
Name	Description
`value`	`ByteString` The bytes for sourceContents to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setState(Workflow.State value)

public Workflow.Builder setState(Workflow.State value)

Output only. State of the workflow deployment.

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

Parameter
Name	Description
`value`	`Workflow.State` The state to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setStateError(Workflow.StateError value)

public Workflow.Builder setStateError(Workflow.StateError value)

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

Parameter
Name	Description
`value`	`Workflow.StateError`

Returns
Type	Description
`Workflow.Builder`

setStateError(Workflow.StateError.Builder builderForValue)

public Workflow.Builder setStateError(Workflow.StateError.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`Workflow.StateError.Builder`

Returns
Type	Description
`Workflow.Builder`

setStateValue(int value)

public Workflow.Builder setStateValue(int value)

Output only. State of the workflow deployment.

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

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for state to set.

Returns
Type	Description
`Workflow.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Workflow.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Workflow.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Workflow.Builder setUpdateTime(Timestamp value)

Output only. The timestamp for when the workflow was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`Timestamp`

Returns
Type	Description
`Workflow.Builder`

setUpdateTime(Timestamp.Builder builderForValue)

public Workflow.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The timestamp for when the workflow was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Workflow.Builder`