com.google.cloud.workflows.v1

Interface WorkflowOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Workflow, Workflow.Builder

public interface WorkflowOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Labels associated with this workflow.
boolean	containsUserEnvVars(String key) Optional.
Workflow.CallLogLevel	getCallLogLevel() Optional.
int	getCallLogLevelValue() Optional.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getCryptoKeyName() Optional.
com.google.protobuf.ByteString	getCryptoKeyNameBytes() Optional.
String	getDescription() Description of the workflow provided by the user.
com.google.protobuf.ByteString	getDescriptionBytes() Description of the workflow provided by the user.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Labels associated with this workflow.
Map<String,String>	getLabelsMap() Labels associated with this workflow.
String	getLabelsOrDefault(String key, String defaultValue) Labels associated with this workflow.
String	getLabelsOrThrow(String key) Labels associated with this workflow.
String	getName() The resource name of the workflow.
com.google.protobuf.ByteString	getNameBytes() The resource name of the workflow.
com.google.protobuf.Timestamp	getRevisionCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getRevisionCreateTimeOrBuilder() Output only.
String	getRevisionId() Output only.
com.google.protobuf.ByteString	getRevisionIdBytes() Output only.
String	getServiceAccount() The service account associated with the latest workflow version.
com.google.protobuf.ByteString	getServiceAccountBytes() The service account associated with the latest workflow version.
Workflow.SourceCodeCase	getSourceCodeCase()
String	getSourceContents() Workflow code to be executed.
com.google.protobuf.ByteString	getSourceContentsBytes() Workflow code to be executed.
Workflow.State	getState() Output only.
Workflow.StateError	getStateError() Output only.
Workflow.StateErrorOrBuilder	getStateErrorOrBuilder() Output only.
int	getStateValue() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
Map<String,String>	getUserEnvVars() Deprecated.
int	getUserEnvVarsCount() Optional.
Map<String,String>	getUserEnvVarsMap() Optional.
String	getUserEnvVarsOrDefault(String key, String defaultValue) Optional.
String	getUserEnvVarsOrThrow(String key) Optional.
boolean	hasCreateTime() Output only.
boolean	hasRevisionCreateTime() Output only.
boolean	hasSourceContents() Workflow code to be executed.
boolean	hasStateError() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Returns:

The bytes for name.

getDescription

String getDescription()

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

string description = 2;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

string description = 2;

Returns:

The bytes for description.

getStateValue

int getStateValue()

 Output only. State of the workflow deployment.
 

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

Returns:

The enum numeric value on the wire for state.

getState

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:

The state.

getRevisionId

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][google.cloud.workflows.v1.Workflow.service_account]
 - [Workflow code to be
 executed][google.cloud.workflows.v1.Workflow.source_contents]

 The format is "000001-a4d", where the first six characters define
 the zero-padded revision ordinal number. They are followed by a hyphen and
 three hexadecimal random characters.
 

string revision_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The revisionId.

getRevisionIdBytes

com.google.protobuf.ByteString getRevisionIdBytes()

 Output only. The revision of the workflow.
 A new revision of a workflow is created as a result of updating the
 following properties of a workflow:

 - [Service account][google.cloud.workflows.v1.Workflow.service_account]
 - [Workflow code to be
 executed][google.cloud.workflows.v1.Workflow.source_contents]

 The format is "000001-a4d", where the first six characters define
 the zero-padded revision ordinal number. They are followed by a hyphen and
 three hexadecimal random characters.
 

string revision_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for revisionId.

hasCreateTime

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:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.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:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

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

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.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];

hasRevisionCreateTime

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:

Whether the revisionCreateTime field is set.

getRevisionCreateTime

com.google.protobuf.Timestamp getRevisionCreateTime()

 Output only. The timestamp for the latest revision of the workflow's
 creation.
 

.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The revisionCreateTime.

getRevisionCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getRevisionCreateTimeOrBuilder()

 Output only. The timestamp for the latest revision of the workflow's
 creation.
 

.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

getServiceAccount

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:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.ByteString getServiceAccountBytes()

 The service account associated with the latest workflow version.
 This service account represents the identity of the workflow and determines
 what permissions the workflow has.
 Format: projects/{project}/serviceAccounts/{account} or {account}

 Using `-` as a wildcard for the `{project}` or not providing one at all
 will infer the project from the account. The `{account}` value can be the
 `email` address or the `unique_id` of the service account.

 If not provided, workflow will use the project's default service account.
 Modifying this field for an existing workflow results in a new workflow
 revision.
 

string service_account = 9;

Returns:

The bytes for serviceAccount.

hasSourceContents

boolean hasSourceContents()

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

string source_contents = 10;

Returns:

Whether the sourceContents field is set.

getSourceContents

String getSourceContents()

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

string source_contents = 10;

Returns:

The sourceContents.

getSourceContentsBytes

com.google.protobuf.ByteString getSourceContentsBytes()

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

string source_contents = 10;

Returns:

The bytes for sourceContents.

getCryptoKeyName

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:

The cryptoKeyName.

getCryptoKeyNameBytes

com.google.protobuf.ByteString getCryptoKeyNameBytes()

 Optional. The resource name of a KMS crypto key used to encrypt or decrypt
 the data associated with the workflow.

 Format:
 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}

 Using `-` as a wildcard for the `{project}` or not providing one at all
 will infer the project from the account.

 If not provided, data associated with the workflow will not be
 CMEK-encrypted.
 

string crypto_key_name = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns:

The bytes for cryptoKeyName.

hasStateError

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:

Whether the stateError field is set.

getStateError

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:

The stateError.

getStateErrorOrBuilder

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

getCallLogLevelValue

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:

The enum numeric value on the wire for callLogLevel.

getCallLogLevel

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:

The callLogLevel.

getUserEnvVarsCount

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

containsUserEnvVars

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

getUserEnvVars

@Deprecated
Map<String,String> getUserEnvVars()

Deprecated.

Use getUserEnvVarsMap() instead.

getUserEnvVarsMap

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

getUserEnvVarsOrDefault

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

getUserEnvVarsOrThrow

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

getSourceCodeCase

Workflow.SourceCodeCase getSourceCodeCase()