- 2.53.0 (latest)
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.1
- 2.1.10
public static final class Workflow.Builder extends GeneratedMessageV3.Builder<Workflow.Builder> implements WorkflowOrBuilderWorkflow 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.BuilderImplements
WorkflowOrBuilderStatic 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 | |
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 | |
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 | |
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 | |
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 | |
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()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.
.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 | |
getLabels()
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.
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.
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.
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.
map<string, string> labels = 8;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getMutableUserEnvVars()
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()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. |
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()
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 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];
| 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 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];
| 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 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];
| 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 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 |
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 | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Workflow.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Workflow.Builder | |
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 | |
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)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Workflow.Builder | |
putAllUserEnvVars(Map<String,String> values)
public Workflow.Builder putAllUserEnvVars(Map<String,String> values)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Workflow.Builder | |
putLabels(String key, String value)
public Workflow.Builder putLabels(String key, String value)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;
| 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)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];
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
Workflow.Builder | |
removeLabels(String key)
public Workflow.Builder removeLabels(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 |
Workflow.Builder | |
removeUserEnvVars(String key)
public Workflow.Builder removeUserEnvVars(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 |
Workflow.Builder | |
setCallLogLevel(Workflow.CallLogLevel value)
public Workflow.Builder setCallLogLevel(Workflow.CallLogLevel value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Workflow.CallLogLevelThe callLogLevel to set. |
| Returns | |
|---|---|
| Type | Description |
Workflow.Builder | This builder for chaining. |
setCallLogLevelValue(int value)
public Workflow.Builder setCallLogLevelValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value | intThe 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 | StringThe 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 | ByteStringThe 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 | StringThe 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 | ByteStringThe 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 | |
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 | StringThe 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 | ByteStringThe 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 | |
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 | StringThe 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 | ByteStringThe bytes for revisionId to set. |
| Returns | |
|---|---|
| Type | Description |
Workflow.Builder | This builder for chaining. |
setServiceAccount(String value)
public Workflow.Builder setServiceAccount(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
Workflow.Builder | This builder for chaining. |
setServiceAccountBytes(ByteString value)
public Workflow.Builder setServiceAccountBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe 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 | StringThe 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 | ByteStringThe 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.StateThe 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 | intThe 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 | |
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 | |