public final class Workflow extends GeneratedMessageV3 implements WorkflowOrBuilder
Workflow program to be executed by Workflows.
Protobuf type google.cloud.workflows.v1.Workflow
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CALL_LOG_LEVEL_FIELD_NUMBER
public static final int CALL_LOG_LEVEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CRYPTO_KEY_NAME_FIELD_NUMBER
public static final int CRYPTO_KEY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REVISION_CREATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REVISION_ID_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_CONTENTS_FIELD_NUMBER
public static final int SOURCE_CONTENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_ERROR_FIELD_NUMBER
public static final int STATE_ERROR_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_ENV_VARS_FIELD_NUMBER
public static final int USER_ENV_VARS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Workflow getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Workflow.Builder newBuilder()
newBuilder(Workflow prototype)
public static Workflow.Builder newBuilder(Workflow prototype)
| Parameter |
| Name |
Description |
prototype |
Workflow
|
public static Workflow parseDelimitedFrom(InputStream input)
public static Workflow parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Workflow parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Workflow parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(CodedInputStream input)
public static Workflow parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(InputStream input)
public static Workflow parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Workflow parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Workflow> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels associated with this workflow.
Labels can contain at most 64 entries. Keys and values can be no longer
than 63 characters and can only contain lowercase letters, numeric
characters, underscores, and dashes. Label keys must start with a letter.
International characters are allowed.
map<string, string> labels = 8;
| Parameter |
| Name |
Description |
key |
String
|
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
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.
|
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];
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()
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.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
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;
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;
| 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 |
|
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.
|
getParserForType()
public Parser<Workflow> getParserForType()
Overrides
getRevisionCreateTime()
public Timestamp getRevisionCreateTime()
Output only. The timestamp for the latest revision of the workflow's
creation.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The revisionCreateTime.
|
getRevisionCreateTimeOrBuilder()
public TimestampOrBuilder getRevisionCreateTimeOrBuilder()
Output only. The timestamp for the latest revision of the workflow's
creation.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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:
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:
string revision_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for revisionId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServiceAccount()
public String getServiceAccount()
The service account associated with the latest workflow version.
This service account represents the identity of the workflow and determines
what permissions the workflow has.
Format: projects/{project}/serviceAccounts/{account} or {account}
Using - as a wildcard for the {project} or not providing one at all
will infer the project from the account. The {account} value can be the
email address or the unique_id of the service account.
If not provided, workflow will use the project's default service account.
Modifying this field for an existing workflow results in a new workflow
revision.
string service_account = 9;
| Returns |
| Type |
Description |
String |
The serviceAccount.
|
getServiceAccountBytes()
public ByteString getServiceAccountBytes()
The service account associated with the latest workflow version.
This service account represents the identity of the workflow and determines
what permissions the workflow has.
Format: projects/{project}/serviceAccounts/{account} or {account}
Using - as a wildcard for the {project} or not providing one at all
will infer the project from the account. The {account} value can be the
email address or the unique_id of the service account.
If not provided, workflow will use the project's default service account.
Modifying this field for an existing workflow results in a new workflow
revision.
string service_account = 9;
| Returns |
| Type |
Description |
ByteString |
The bytes for serviceAccount.
|
getSourceCodeCase()
public Workflow.SourceCodeCase getSourceCodeCase()
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];
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];
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];
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.
|
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];
getUserEnvVars() (deprecated)
public Map<String,String> getUserEnvVars()
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];
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];
| 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Workflow.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Workflow.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Workflow.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
