Interface WorkflowOrBuilder (2.33.0)

Version 2.33.0

• 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 interface WorkflowOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

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

getCreateTimeOrBuilder()

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

getDescription()

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

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

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

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Workflow.SourceCodeCase getSourceCodeCase()

Returns
Type	Description
Workflow.SourceCodeCase

getSourceContents()

public abstract String getSourceContents()

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

string source_contents = 10;

Returns
Type	Description
String	The sourceContents.

getSourceContentsBytes()

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

getUpdateTimeOrBuilder()

public abstract 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 abstract Map<String,String> getUserEnvVars()

Use #getUserEnvVarsMap() instead.

Returns
Type	Description
Map<String,String>

getUserEnvVarsCount()

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