Package com.google.cloud.workflows.v1beta

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 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.v1beta.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.v1beta.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 fields of a workflow:
 - `source_code`
 - `service_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];
        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 fields of a workflow:
 - `source_code`
 - `service_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];
        Returns:
        The bytes for revisionId.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The timestamp of 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 of 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 of when the workflow was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The last update timestamp of the workflow.
        .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 last update timestamp of the workflow.
        .google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

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

      • hasRevisionCreateTime

        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];
        Returns:
        Whether the revisionCreateTime field is set.

      • getRevisionCreateTime

        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];
        Returns:
        The revisionCreateTime.

      • getRevisionCreateTimeOrBuilder

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

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

      • 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()
         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;
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        com.google.protobuf.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;
        Returns:
        The bytes for serviceAccount.

      • hasSourceContents

        boolean hasSourceContents()
         Workflow code to be executed. The size limit is 32KB.
        string source_contents = 10;
        Returns:
        Whether the sourceContents field is set.

      • getSourceContents

        String getSourceContents()
         Workflow code to be executed. The size limit is 32KB.
        string source_contents = 10;
        Returns:
        The sourceContents.

      • getSourceContentsBytes

        com.google.protobuf.ByteString getSourceContentsBytes()
         Workflow code to be executed. The size limit is 32KB.
        string source_contents = 10;
        Returns:
        The bytes for sourceContents.