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

Class Execution

  • All Implemented Interfaces:
    ExecutionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Execution
extends com.google.protobuf.GeneratedMessageV3
implements ExecutionOrBuilder
     A running instance of a
 [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows).
    Protobuf type google.cloud.workflows.executions.v1.Execution
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • getName

        public 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];
        Specified by:
        getName in interface ExecutionOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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];
        Specified by:
        getNameBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for name.

      • hasStartTime

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

      • getStartTime

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

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Output only. Marks the beginning of execution.
        .google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStartTimeOrBuilder in interface ExecutionOrBuilder

      • hasEndTime

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

      • getEndTime

        public 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];
        Specified by:
        getEndTime in interface ExecutionOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

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

      • hasDuration

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

      • getDuration

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

      • getDurationOrBuilder

        public com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
         Output only. Measures the duration of the execution.
        .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDurationOrBuilder in interface ExecutionOrBuilder

      • getStateValue

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

      • getState

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

      • getArgument

        public 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;
        Specified by:
        getArgument in interface ExecutionOrBuilder
        Returns:
        The argument.

      • getArgumentBytes

        public 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;
        Specified by:
        getArgumentBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for argument.

      • getResult

        public 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];
        Specified by:
        getResult in interface ExecutionOrBuilder
        Returns:
        The result.

      • getResultBytes

        public 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];
        Specified by:
        getResultBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for result.

      • hasError

        public 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];
        Specified by:
        hasError in interface ExecutionOrBuilder
        Returns:
        Whether the error field is set.

      • getError

        public 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];
        Specified by:
        getError in interface ExecutionOrBuilder
        Returns:
        The error.

      • getErrorOrBuilder

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

      • getWorkflowRevisionId

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

      • getWorkflowRevisionIdBytes

        public 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];
        Specified by:
        getWorkflowRevisionIdBytes in interface ExecutionOrBuilder
        Returns:
        The bytes for workflowRevisionId.

      • getCallLogLevelValue

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

      • getCallLogLevel

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

      • hasStatus

        public 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];
        Specified by:
        hasStatus in interface ExecutionOrBuilder
        Returns:
        Whether the status field is set.

      • getStatus

        public 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];
        Specified by:
        getStatus in interface ExecutionOrBuilder
        Returns:
        The status.

      • getStatusOrBuilder

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

      • getLabelsCount

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

      • containsLabels

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

      • getLabelsMap

        public 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;
        Specified by:
        getLabelsMap in interface ExecutionOrBuilder

      • getLabelsOrDefault

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

      • getLabelsOrThrow

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

      • hasStateError

        public 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];
        Specified by:
        hasStateError in interface ExecutionOrBuilder
        Returns:
        Whether the stateError field is set.

      • getStateError

        public 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];
        Specified by:
        getStateError in interface ExecutionOrBuilder
        Returns:
        The stateError.

      • getStateErrorOrBuilder

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

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 Execution parseFrom​(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Execution.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Execution getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Execution> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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