Class Execution (2.60.0) 

publicfinalclass ExecutionextendsGeneratedMessageV3implementsExecutionOrBuilder

A running instance of a Workflow.

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

Implements

ExecutionOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

ARGUMENT_FIELD_NUMBER

publicstaticfinalintARGUMENT_FIELD_NUMBER
Field Value
Type Description
int

CALL_LOG_LEVEL_FIELD_NUMBER

publicstaticfinalintCALL_LOG_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

publicstaticfinalintDURATION_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

publicstaticfinalintEND_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

publicstaticfinalintERROR_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

publicstaticfinalintLABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

RESULT_FIELD_NUMBER

publicstaticfinalintRESULT_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

publicstaticfinalintSTART_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_ERROR_FIELD_NUMBER

publicstaticfinalintSTATE_ERROR_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

publicstaticfinalintSTATE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

publicstaticfinalintSTATUS_FIELD_NUMBER
Field Value
Type Description
int

WORKFLOW_REVISION_ID_FIELD_NUMBER

publicstaticfinalintWORKFLOW_REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticExecutiongetDefaultInstance()
Returns
Type Description
Execution

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticExecution.BuildernewBuilder()
Returns
Type Description
Execution.Builder

newBuilder(Execution prototype)

publicstaticExecution.BuildernewBuilder(Executionprototype)
Parameter
Name Description
prototype Execution
Returns
Type Description
Execution.Builder

parseDelimitedFrom(InputStream input)

publicstaticExecutionparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExecutionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticExecutionparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticExecutionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticExecutionparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticExecutionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticExecutionparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExecutionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticExecutionparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticExecutionparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticExecutionparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticExecutionparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<Execution>parser()
Returns
Type Description
Parser<Execution>

Methods

containsLabels(String key)

publicbooleancontainsLabels(Stringkey)

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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArgument()

publicStringgetArgument()

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
Type Description
String

The argument.

getArgumentBytes()

publicByteStringgetArgumentBytes()

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
Type Description
ByteString

The bytes for argument.

getCallLogLevel()

publicExecution.CallLogLevelgetCallLogLevel()

The call logging level associated to this execution.

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

Returns
Type Description
Execution.CallLogLevel

The callLogLevel.

getCallLogLevelValue()

publicintgetCallLogLevelValue()

The call logging level associated to this execution.

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

Returns
Type Description
int

The enum numeric value on the wire for callLogLevel.

getDefaultInstanceForType()

publicExecutiongetDefaultInstanceForType()
Returns
Type Description
Execution

getDuration()

publicDurationgetDuration()

Output only. Measures the duration of the execution.

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

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

publicDurationOrBuildergetDurationOrBuilder()

Output only. Measures the duration of the execution.

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

Returns
Type Description
DurationOrBuilder

getEndTime()

publicTimestampgetEndTime()

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

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

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

publicTimestampOrBuildergetEndTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getError()

publicExecution.ErrorgetError()

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
Type Description
Execution.Error

The error.

getErrorOrBuilder()

publicExecution.ErrorOrBuildergetErrorOrBuilder()

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
Type Description
Execution.ErrorOrBuilder

getLabels() (deprecated)

publicMap<String,String>getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

publicintgetLabelsCount()

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
Type Description
int

getLabelsMap()

publicMap<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
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)

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
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

publicStringgetLabelsOrThrow(Stringkey)

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
Name Description
key String
Returns
Type Description
String

getName()

publicStringgetName()

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
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

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
Type Description
ByteString

The bytes for name.

getParserForType()

publicParser<Execution>getParserForType()
Returns
Type Description
Parser<Execution>
Overrides

getResult()

publicStringgetResult()

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
Type Description
String

The result.

getResultBytes()

publicByteStringgetResultBytes()

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
Type Description
ByteString

The bytes for result.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

publicTimestampgetStartTime()

Output only. Marks the beginning of execution.

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

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

publicTimestampOrBuildergetStartTimeOrBuilder()

Output only. Marks the beginning of execution.

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

Returns
Type Description
TimestampOrBuilder

getState()

publicExecution.StategetState()

Output only. Current state of the execution.

.google.cloud.workflows.executions.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.State

The state.

getStateError()

publicExecution.StateErrorgetStateError()

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
Type Description
Execution.StateError

The stateError.

getStateErrorOrBuilder()

publicExecution.StateErrorOrBuildergetStateErrorOrBuilder()

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
Type Description
Execution.StateErrorOrBuilder

getStateValue()

publicintgetStateValue()

Output only. Current state of the execution.

.google.cloud.workflows.executions.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStatus()

publicExecution.StatusgetStatus()

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
Type Description
Execution.Status

The status.

getStatusOrBuilder()

publicExecution.StatusOrBuildergetStatusOrBuilder()

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
Type Description
Execution.StatusOrBuilder

getWorkflowRevisionId()

publicStringgetWorkflowRevisionId()

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

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

Returns
Type Description
String

The workflowRevisionId.

getWorkflowRevisionIdBytes()

publicByteStringgetWorkflowRevisionIdBytes()

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

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

Returns
Type Description
ByteString

The bytes for workflowRevisionId.

hasDuration()

publicbooleanhasDuration()

Output only. Measures the duration of the execution.

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

Returns
Type Description
boolean

Whether the duration field is set.

hasEndTime()

publicbooleanhasEndTime()

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

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

Returns
Type Description
boolean

Whether the endTime field is set.

hasError()

publicbooleanhasError()

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
Type Description
boolean

Whether the error field is set.

hasStartTime()

publicbooleanhasStartTime()

Output only. Marks the beginning of execution.

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

Returns
Type Description
boolean

Whether the startTime field is set.

hasStateError()

publicbooleanhasStateError()

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
Type Description
boolean

Whether the stateError field is set.

hasStatus()

publicbooleanhasStatus()

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
Type Description
boolean

Whether the status field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicExecution.BuildernewBuilderForType()
Returns
Type Description
Execution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedExecution.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Execution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicExecution.BuildertoBuilder()
Returns
Type Description
Execution.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.