Class Execution (2.35.0)

public final class Execution extends GeneratedMessageV3 implements ExecutionOrBuilder

A running instance of a Workflow.

Protobuf type google.cloud.workflows.executions.v1.Execution

Implements

ExecutionOrBuilder

Static Fields

ARGUMENT_FIELD_NUMBER

public static final int ARGUMENT_FIELD_NUMBER
Field Value
TypeDescription
int

CALL_LOG_LEVEL_FIELD_NUMBER

public static final int CALL_LOG_LEVEL_FIELD_NUMBER
Field Value
TypeDescription
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

RESULT_FIELD_NUMBER

public static final int RESULT_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_ERROR_FIELD_NUMBER

public static final int STATE_ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

WORKFLOW_REVISION_ID_FIELD_NUMBER

public static final int WORKFLOW_REVISION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Execution getDefaultInstance()
Returns
TypeDescription
Execution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Execution.Builder newBuilder()
Returns
TypeDescription
Execution.Builder

newBuilder(Execution prototype)

public static Execution.Builder newBuilder(Execution prototype)
Parameter
NameDescription
prototypeExecution
Returns
TypeDescription
Execution.Builder

parseDelimitedFrom(InputStream input)

public static Execution parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Execution
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Execution
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Execution parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Execution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Execution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Execution parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Execution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Execution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Execution parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Execution
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Execution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Execution parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Execution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Execution
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Execution parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Execution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Execution
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Execution> parser()
Returns
TypeDescription
Parser<Execution>

Methods

containsLabels(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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;

Returns
TypeDescription
String

The argument.

getArgumentBytes()

public 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
TypeDescription
ByteString

The bytes for argument.

getCallLogLevel()

public Execution.CallLogLevel getCallLogLevel()

The call logging level associated to this execution.

.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;

Returns
TypeDescription
Execution.CallLogLevel

The callLogLevel.

getCallLogLevelValue()

public int getCallLogLevelValue()

The call logging level associated to this execution.

.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;

Returns
TypeDescription
int

The enum numeric value on the wire for callLogLevel.

getDefaultInstanceForType()

public Execution getDefaultInstanceForType()
Returns
TypeDescription
Execution

getDuration()

public Duration getDuration()

Output only. Measures the duration of the execution.

.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Output only. Measures the duration of the execution.

.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
DurationOrBuilder

getEndTime()

public 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
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Marks the end of execution, successful or not.

.google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

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

Returns
TypeDescription
Execution.Error

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

Returns
TypeDescription
Execution.ErrorOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

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

Returns
TypeDescription
int

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;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

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

Returns
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Execution> getParserForType()
Returns
TypeDescription
Parser<Execution>
Overrides

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

Returns
TypeDescription
String

The result.

getResultBytes()

public 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
TypeDescription
ByteString

The bytes for result.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. Marks the beginning of execution.

.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Marks the beginning of execution.

.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

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

Returns
TypeDescription
Execution.State

The state.

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

Returns
TypeDescription
Execution.StateError

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

Returns
TypeDescription
Execution.StateErrorOrBuilder

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

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

Returns
TypeDescription
Execution.Status

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

Returns
TypeDescription
Execution.StatusOrBuilder

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

Returns
TypeDescription
String

The workflowRevisionId.

getWorkflowRevisionIdBytes()

public ByteString getWorkflowRevisionIdBytes()

Output only. Revision of the workflow this execution is using.

string workflow_revision_id = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for workflowRevisionId.

hasDuration()

public boolean hasDuration()

Output only. Measures the duration of the execution.

.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the duration field is set.

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

Returns
TypeDescription
boolean

Whether the endTime field is set.

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

Returns
TypeDescription
boolean

Whether the error field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Marks the beginning of execution.

.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the startTime field is set.

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

Returns
TypeDescription
boolean

Whether the stateError field is set.

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

Returns
TypeDescription
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Execution.Builder newBuilderForType()
Returns
TypeDescription
Execution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Execution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Execution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Execution.Builder toBuilder()
Returns
TypeDescription
Execution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException