Package com.google.cloud.workflows.v1beta

Class Workflow

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.workflows.v1beta.Workflow
All Implemented Interfaces:
WorkflowOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Workflow extends com.google.protobuf.GeneratedMessage implements WorkflowOrBuilder
 Workflow program to be executed by Workflows.
Protobuf type google.cloud.workflows.v1beta.Workflow
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • REVISION_ID_FIELD_NUMBER

      public static final int REVISION_ID_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • REVISION_CREATE_TIME_FIELD_NUMBER

      public static final int REVISION_CREATE_TIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • SERVICE_ACCOUNT_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_FIELD_NUMBER
      See Also:

    • SOURCE_CONTENTS_FIELD_NUMBER

      public static final int SOURCE_CONTENTS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getSourceCodeCase

      public Workflow.SourceCodeCase getSourceCodeCase()
      Specified by:
      getSourceCodeCase in interface WorkflowOrBuilder

    • getName

      public String getName()
       The resource name of the workflow.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string name = 1;
      Specified by:
      getName in interface WorkflowOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The resource name of the workflow.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string name = 1;
      Specified by:
      getNameBytes in interface WorkflowOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      public String getDescription()
       Description of the workflow provided by the user.
 Must be at most 1000 unicode characters long.
      string description = 2;
      Specified by:
      getDescription in interface WorkflowOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Description of the workflow provided by the user.
 Must be at most 1000 unicode characters long.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface WorkflowOrBuilder
      Returns:
      The bytes for description.

    • 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];
      Specified by:
      getStateValue in interface WorkflowOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface WorkflowOrBuilder
      Returns:
      The state.

    • 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:

 - [Service account][google.cloud.workflows.v1beta.Workflow.service_account]
 - [Workflow code to be
 executed][google.cloud.workflows.v1beta.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];
      Specified by:
      getRevisionId in interface WorkflowOrBuilder
      Returns:
      The revisionId.

    • getRevisionIdBytes

      public 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.v1beta.Workflow.service_account]
 - [Workflow code to be
 executed][google.cloud.workflows.v1beta.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];
      Specified by:
      getRevisionIdBytes in interface WorkflowOrBuilder
      Returns:
      The bytes for revisionId.

    • 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];
      Specified by:
      hasCreateTime in interface WorkflowOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface WorkflowOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface WorkflowOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface WorkflowOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface WorkflowOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface WorkflowOrBuilder

    • 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];
      Specified by:
      hasRevisionCreateTime in interface WorkflowOrBuilder
      Returns:
      Whether the revisionCreateTime field is set.

    • getRevisionCreateTime

      public 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];
      Specified by:
      getRevisionCreateTime in interface WorkflowOrBuilder
      Returns:
      The revisionCreateTime.

    • getRevisionCreateTimeOrBuilder

      public 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];
      Specified by:
      getRevisionCreateTimeOrBuilder in interface WorkflowOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: WorkflowOrBuilder
       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;
      Specified by:
      getLabelsCount in interface WorkflowOrBuilder

    • containsLabels

      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;
      Specified by:
      containsLabels in interface WorkflowOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface WorkflowOrBuilder

    • 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;
      Specified by:
      getLabelsMap in interface WorkflowOrBuilder

    • getLabelsOrDefault

      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;
      Specified by:
      getLabelsOrDefault in interface WorkflowOrBuilder

    • getLabelsOrThrow

      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;
      Specified by:
      getLabelsOrThrow in interface WorkflowOrBuilder

    • 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;
      Specified by:
      getServiceAccount in interface WorkflowOrBuilder
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      public 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;
      Specified by:
      getServiceAccountBytes in interface WorkflowOrBuilder
      Returns:
      The bytes for serviceAccount.

    • hasSourceContents

      public boolean hasSourceContents()
       Workflow code to be executed. The size limit is 128KB.
      string source_contents = 10;
      Specified by:
      hasSourceContents in interface WorkflowOrBuilder
      Returns:
      Whether the sourceContents field is set.

    • getSourceContents

      public String getSourceContents()
       Workflow code to be executed. The size limit is 128KB.
      string source_contents = 10;
      Specified by:
      getSourceContents in interface WorkflowOrBuilder
      Returns:
      The sourceContents.

    • getSourceContentsBytes

      public com.google.protobuf.ByteString getSourceContentsBytes()
       Workflow code to be executed. The size limit is 128KB.
      string source_contents = 10;
      Specified by:
      getSourceContentsBytes in interface WorkflowOrBuilder
      Returns:
      The bytes for sourceContents.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Workflow parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Workflow parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Workflow parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Workflow parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Workflow parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Workflow parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Workflow parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Workflow parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Workflow parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Workflow parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Workflow parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Workflow parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Workflow.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Workflow.Builder newBuilder()

    • newBuilder

      public static Workflow.Builder newBuilder(Workflow prototype)

    • toBuilder

      public Workflow.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Workflow.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Workflow getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Workflow> parser()

    • getParserForType

      public com.google.protobuf.Parser<Workflow> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Workflow getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder