public final class Workflow extends GeneratedMessageV3 implements WorkflowOrBuilder
Workflow program to be executed by Workflows.
Protobuf type google.cloud.workflows.v1beta.Workflow
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
REVISION_CREATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
Field Value
REVISION_ID_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
Field Value
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
SOURCE_CONTENTS_FIELD_NUMBER
public static final int SOURCE_CONTENTS_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Workflow getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Workflow.Builder newBuilder()
Returns
newBuilder(Workflow prototype)
public static Workflow.Builder newBuilder(Workflow prototype)
Parameter
Returns
public static Workflow parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Workflow parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Workflow parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Workflow parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Workflow parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Workflow parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Workflow parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Workflow parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Workflow parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Workflow parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Workflow> parser()
Returns
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp of when the workflow was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp of when the workflow was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Workflow getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
Description of the workflow provided by the user.
Must be at most 1000 unicode characters long.
string description = 2;
| 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;
| Type | Description |
| ByteString | The bytes for description.
|
getLabels()
public Map<String,String> getLabels()
Returns
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;
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;
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;
getName()
The resource name of the workflow.
Format: projects/{project}/locations/{location}/workflows/{workflow}
string name = 1;
| 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;
getParserForType()
public Parser<Workflow> getParserForType()
Returns
Overrides
getRevisionCreateTime()
public Timestamp getRevisionCreateTime()
Output only. The timestamp that the latest revision of the workflow
was created.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The revisionCreateTime.
|
getRevisionCreateTimeOrBuilder()
public TimestampOrBuilder getRevisionCreateTimeOrBuilder()
Output only. The timestamp that the latest revision of the workflow
was created.
.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 fields of a workflow:
source_codeservice_account
The format is "000001-a4d", where the first 6 characters define
the zero-padded revision ordinal number. They are followed by a hyphen and
3 hexadecimal random characters.
string revision_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 fields of a workflow:
source_codeservice_account
The format is "000001-a4d", where the first 6 characters define
the zero-padded revision ordinal number. They are followed by a hyphen and
3 hexadecimal random characters.
string revision_id = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for revisionId.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServiceAccount()
public String getServiceAccount()
Name of 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}
Using - as a wildcard for the {project} 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;
| Type | Description |
| String | The serviceAccount.
|
getServiceAccountBytes()
public ByteString getServiceAccountBytes()
Name of 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}
Using - as a wildcard for the {project} 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;
| Type | Description |
| ByteString | The bytes for serviceAccount.
|
getSourceCodeCase()
public Workflow.SourceCodeCase getSourceCodeCase()
Returns
getSourceContents()
public String getSourceContents()
Workflow code to be executed. The size limit is 32KB.
string source_contents = 10;
| Type | Description |
| String | The sourceContents.
|
getSourceContentsBytes()
public ByteString getSourceContentsBytes()
Workflow code to be executed. The size limit is 32KB.
string source_contents = 10;
| Type | Description |
| ByteString | The bytes for sourceContents.
|
getState()
public Workflow.State getState()
Output only. State of the workflow deployment.
.google.cloud.workflows.v1beta.Workflow.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. State of the workflow deployment.
.google.cloud.workflows.v1beta.Workflow.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The last update timestamp of the workflow.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of the workflow.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp of when the workflow was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasRevisionCreateTime()
public boolean hasRevisionCreateTime()
Output only. The timestamp that the latest revision of the workflow
was created.
.google.protobuf.Timestamp revision_create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the revisionCreateTime field is set.
|
hasSourceContents()
public boolean hasSourceContents()
Workflow code to be executed. The size limit is 32KB.
string source_contents = 10;
| Type | Description |
| boolean | Whether the sourceContents field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The last update timestamp of the workflow.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Workflow.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Workflow.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Workflow.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
