public final class Workflow extends com.google.protobuf.GeneratedMessageV3 implements WorkflowOrBuilder
Workflow program to be executed by Workflows.Protobuf type
google.cloud.workflows.v1.Workflow| Modifier and Type | Class and Description |
|---|---|
static class |
Workflow.Builder
Workflow program to be executed by Workflows.
|
static class |
Workflow.SourceCodeCase |
static class |
Workflow.State
Describes the current state of workflow deployment.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
REVISION_CREATE_TIME_FIELD_NUMBER |
static int |
REVISION_ID_FIELD_NUMBER |
static int |
SERVICE_ACCOUNT_FIELD_NUMBER |
static int |
SOURCE_CONTENTS_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
Labels associated with this workflow.
|
boolean |
equals(Object obj) |
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static Workflow |
getDefaultInstance() |
Workflow |
getDefaultInstanceForType() |
String |
getDescription()
Description of the workflow provided by the user.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
Description of the workflow provided by the user.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.Parser<Workflow> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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.
|
int |
getStateValue()
Output only.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasRevisionCreateTime()
Output only.
|
boolean |
hasSourceContents()
Workflow code to be executed.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static Workflow.Builder |
newBuilder() |
static Workflow.Builder |
newBuilder(Workflow prototype) |
Workflow.Builder |
newBuilderForType() |
protected Workflow.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Workflow |
parseDelimitedFrom(InputStream input) |
static Workflow |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Workflow |
parseFrom(byte[] data) |
static Workflow |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Workflow |
parseFrom(ByteBuffer data) |
static Workflow |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Workflow |
parseFrom(com.google.protobuf.ByteString data) |
static Workflow |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Workflow |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Workflow |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Workflow |
parseFrom(InputStream input) |
static Workflow |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Workflow> |
parser() |
Workflow.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SOURCE_CONTENTS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Workflow.SourceCodeCase getSourceCodeCase()
getSourceCodeCase in interface WorkflowOrBuilderpublic String getName()
The resource name of the workflow.
Format: projects/{project}/locations/{location}/workflows/{workflow}
string name = 1;getName in interface WorkflowOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
The resource name of the workflow.
Format: projects/{project}/locations/{location}/workflows/{workflow}
string name = 1;getNameBytes in interface WorkflowOrBuilderpublic String getDescription()
Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
string description = 2;getDescription in interface WorkflowOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
Description of the workflow provided by the user. Must be at most 1000 unicode characters long.
string description = 2;getDescriptionBytes in interface WorkflowOrBuilderpublic int getStateValue()
Output only. State of the workflow deployment.
.google.cloud.workflows.v1.Workflow.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface WorkflowOrBuilderpublic Workflow.State getState()
Output only. State of the workflow deployment.
.google.cloud.workflows.v1.Workflow.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface WorkflowOrBuilderpublic 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 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];getRevisionId in interface WorkflowOrBuilderpublic 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 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];getRevisionIdBytes in interface WorkflowOrBuilderpublic boolean hasCreateTime()
Output only. The timestamp of when the workflow was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface WorkflowOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. The timestamp of when the workflow was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface WorkflowOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp of when the workflow was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface WorkflowOrBuilderpublic boolean hasUpdateTime()
Output only. The last update timestamp of the workflow.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface WorkflowOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. The last update timestamp of the workflow.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface WorkflowOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The last update timestamp of the workflow.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface WorkflowOrBuilderpublic 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];
hasRevisionCreateTime in interface WorkflowOrBuilderpublic com.google.protobuf.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];
getRevisionCreateTime in interface WorkflowOrBuilderpublic com.google.protobuf.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];
getRevisionCreateTimeOrBuilder in interface WorkflowOrBuilderpublic int getLabelsCount()
WorkflowOrBuilderLabels 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;getLabelsCount in interface WorkflowOrBuilderpublic 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;containsLabels in interface WorkflowOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface WorkflowOrBuilderpublic 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;getLabelsMap in interface WorkflowOrBuilderpublic 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;getLabelsOrDefault in interface WorkflowOrBuilderpublic 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;getLabelsOrThrow in interface WorkflowOrBuilderpublic 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;getServiceAccount in interface WorkflowOrBuilderpublic 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;getServiceAccountBytes in interface WorkflowOrBuilderpublic boolean hasSourceContents()
Workflow code to be executed. The size limit is 128KB.
string source_contents = 10;hasSourceContents in interface WorkflowOrBuilderpublic String getSourceContents()
Workflow code to be executed. The size limit is 128KB.
string source_contents = 10;getSourceContents in interface WorkflowOrBuilderpublic com.google.protobuf.ByteString getSourceContentsBytes()
Workflow code to be executed. The size limit is 128KB.
string source_contents = 10;getSourceContentsBytes in interface WorkflowOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Workflow parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Workflow parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Workflow parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Workflow parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Workflow parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Workflow parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Workflow parseFrom(InputStream input) throws IOException
IOExceptionpublic static Workflow parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Workflow parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Workflow parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Workflow parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Workflow parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Workflow.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Workflow.Builder newBuilder()
public static Workflow.Builder newBuilder(Workflow prototype)
public Workflow.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Workflow.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Workflow getDefaultInstance()
public static com.google.protobuf.Parser<Workflow> parser()
public com.google.protobuf.Parser<Workflow> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Workflow getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.