Class Execution (2.48.0) 

public final class Execution extends GeneratedMessageV3 implements ExecutionOrBuilder

A running instance of a Workflow.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Execution

Implements

ExecutionOrBuilder

Static Fields

ARGUMENT_FIELD_NUMBER

public static final int ARGUMENT_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESULT_FIELD_NUMBER

public static final int RESULT_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

WORKFLOW_REVISION_ID_FIELD_NUMBER

public static final int WORKFLOW_REVISION_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Execution getDefaultInstance()
Returns
Type Description
Execution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Execution.Builder newBuilder()
Returns
Type Description
Execution.Builder

newBuilder(Execution prototype)

public static Execution.Builder newBuilder(Execution prototype)
Parameter
Name Description
prototype Execution
Returns
Type Description
Execution.Builder

parseDelimitedFrom(InputStream input)

public static Execution parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Execution parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Execution parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Execution parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Execution parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Execution parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Execution> parser()
Returns
Type Description
Parser<Execution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArgument()

public String getArgument()

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

string argument = 5;

Returns
Type Description
String

The argument.

getArgumentBytes()

public ByteString getArgumentBytes()

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

string argument = 5;

Returns
Type Description
ByteString

The bytes for argument.

getDefaultInstanceForType()

public Execution getDefaultInstanceForType()
Returns
Type Description
Execution

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
Type Description
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
Type Description
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.v1beta.Execution.Error error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1beta.Execution.Error error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.ErrorOrBuilder

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

The bytes for name.

getParserForType()

public Parser<Execution> getParserForType()
Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for result.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getState()

public Execution.State getState()

Output only. Current state of the execution.

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

Returns
Type Description
Execution.State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the execution.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

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

The bytes for workflowRevisionId.

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
Type Description
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.v1beta.Execution.Error error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Execution.Builder newBuilderForType()
Returns
Type Description
Execution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Execution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Execution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Execution.Builder toBuilder()
Returns
Type Description
Execution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException