Package com.google.cloud.workflows.executions.v1

Interface ExecutionOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Execution, Execution.Builder
    public interface ExecutionOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Output only. The resource name of the execution.
 Format:
 projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the execution.
 Format:
 projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for name.

      • hasStartTime

        boolean hasStartTime()
         Output only. Marks the beginning of execution.
        .google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the startTime field is set.

      • getStartTime

        com.google.protobuf.Timestamp getStartTime()
         Output only. Marks the beginning of execution.
        .google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Marks the beginning of execution.
        .google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasEndTime

        boolean hasEndTime()
         Output only. Marks the end of execution, successful or not.
        .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the endTime field is set.

      • getEndTime

        com.google.protobuf.Timestamp getEndTime()
         Output only. Marks the end of execution, successful or not.
        .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         Output only. Marks the end of execution, successful or not.
        .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasDuration

        boolean hasDuration()
         Output only. Measures the duration of the execution.
        .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the duration field is set.

      • getDuration

        com.google.protobuf.Duration getDuration()
         Output only. Measures the duration of the execution.
        .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The duration.

      • getDurationOrBuilder

        com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
         Output only. Measures the duration of the execution.
        .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStateValue

        int getStateValue()
         Output only. Current state of the execution.
        .google.cloud.workflows.executions.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        Execution.State getState()
         Output only. Current state of the execution.
        .google.cloud.workflows.executions.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getArgument

        String getArgument()
         Input parameters of the execution represented as a JSON string.
 The size limit is 32KB.

 *Note*: If you are using the REST API directly to run your workflow, you
 must escape any JSON string value of `argument`. Example:
 `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'`
        string argument = 5;
        Returns:
        The argument.

      • getArgumentBytes

        com.google.protobuf.ByteString getArgumentBytes()
         Input parameters of the execution represented as a JSON string.
 The size limit is 32KB.

 *Note*: If you are using the REST API directly to run your workflow, you
 must escape any JSON string value of `argument`. Example:
 `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'`
        string argument = 5;
        Returns:
        The bytes for argument.

      • getResult

        String getResult()
         Output only. Output of the execution represented as a JSON string. The
 value can only be present if the execution's state is `SUCCEEDED`.
        string result = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The result.

      • getResultBytes

        com.google.protobuf.ByteString getResultBytes()
         Output only. Output of the execution represented as a JSON string. The
 value can only be present if the execution's state is `SUCCEEDED`.
        string result = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for result.

      • hasError

        boolean hasError()
         Output only. The error which caused the execution to finish prematurely.
 The value is only present if the execution's state is `FAILED`
 or `CANCELLED`.
        .google.cloud.workflows.executions.v1.Execution.Error error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the error field is set.

      • getError

        Execution.Error getError()
         Output only. The error which caused the execution to finish prematurely.
 The value is only present if the execution's state is `FAILED`
 or `CANCELLED`.
        .google.cloud.workflows.executions.v1.Execution.Error error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The error.

      • getErrorOrBuilder

        Execution.ErrorOrBuilder getErrorOrBuilder()
         Output only. The error which caused the execution to finish prematurely.
 The value is only present if the execution's state is `FAILED`
 or `CANCELLED`.
        .google.cloud.workflows.executions.v1.Execution.Error error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getWorkflowRevisionId

        String getWorkflowRevisionId()
         Output only. Revision of the workflow this execution is using.
        string workflow_revision_id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The workflowRevisionId.

      • getWorkflowRevisionIdBytes

        com.google.protobuf.ByteString getWorkflowRevisionIdBytes()
         Output only. Revision of the workflow this execution is using.
        string workflow_revision_id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for workflowRevisionId.

      • getCallLogLevelValue

        int getCallLogLevelValue()
         The call logging level associated to this execution.
        .google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;
        Returns:
        The enum numeric value on the wire for callLogLevel.

      • getCallLogLevel

        Execution.CallLogLevel getCallLogLevel()
         The call logging level associated to this execution.
        .google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;
        Returns:
        The callLogLevel.

      • hasStatus

        boolean hasStatus()
         Output only. Status tracks the current steps and progress data of this
 execution.
        .google.cloud.workflows.executions.v1.Execution.Status status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the status field is set.

      • getStatus

        Execution.Status getStatus()
         Output only. Status tracks the current steps and progress data of this
 execution.
        .google.cloud.workflows.executions.v1.Execution.Status status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The status.

      • getStatusOrBuilder

        Execution.StatusOrBuilder getStatusOrBuilder()
         Output only. Status tracks the current steps and progress data of this
 execution.
        .google.cloud.workflows.executions.v1.Execution.Status status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getLabelsCount

        int getLabelsCount()
         Labels associated with this execution.
 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.
 By default, labels are inherited from the workflow but are overridden by
 any labels associated with the execution.
        map<string, string> labels = 11;

      • containsLabels

        boolean containsLabels​(String key)
         Labels associated with this execution.
 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.
 By default, labels are inherited from the workflow but are overridden by
 any labels associated with the execution.
        map<string, string> labels = 11;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels associated with this execution.
 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.
 By default, labels are inherited from the workflow but are overridden by
 any labels associated with the execution.
        map<string, string> labels = 11;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels associated with this execution.
 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.
 By default, labels are inherited from the workflow but are overridden by
 any labels associated with the execution.
        map<string, string> labels = 11;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels associated with this execution.
 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.
 By default, labels are inherited from the workflow but are overridden by
 any labels associated with the execution.
        map<string, string> labels = 11;

      • hasStateError

        boolean hasStateError()
         Output only. Error regarding the state of the Execution resource. For
 example, this field will have error details if the execution data is
 unavailable due to revoked KMS key permissions.
        .google.cloud.workflows.executions.v1.Execution.StateError state_error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the stateError field is set.

      • getStateError

        Execution.StateError getStateError()
         Output only. Error regarding the state of the Execution resource. For
 example, this field will have error details if the execution data is
 unavailable due to revoked KMS key permissions.
        .google.cloud.workflows.executions.v1.Execution.StateError state_error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The stateError.

      • getStateErrorOrBuilder

        Execution.StateErrorOrBuilder getStateErrorOrBuilder()
         Output only. Error regarding the state of the Execution resource. For
 example, this field will have error details if the execution data is
 unavailable due to revoked KMS key permissions.
        .google.cloud.workflows.executions.v1.Execution.StateError state_error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];