Class Execution.Builder (2.45.0) 

public static final class Execution.Builder extends GeneratedMessageV3.Builder<Execution.Builder> implements ExecutionOrBuilder

A running instance of a Workflow.

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

Inheritance

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

Implements

ExecutionOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Execution.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Execution.Builder
Overrides

build()

public Execution build()
Returns
Type Description
Execution

buildPartial()

public Execution buildPartial()
Returns
Type Description
Execution

clear()

public Execution.Builder clear()
Returns
Type Description
Execution.Builder
Overrides

clearArgument()

public Execution.Builder clearArgument()

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

string argument = 5;

Returns
Type Description
Execution.Builder

This builder for chaining.

clearEndTime()

public Execution.Builder clearEndTime()

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
Execution.Builder

clearError()

public Execution.Builder clearError()

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.Builder

clearField(Descriptors.FieldDescriptor field)

public Execution.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Execution.Builder
Overrides

clearName()

public Execution.Builder clearName()

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
Execution.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Execution.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Execution.Builder
Overrides

clearResult()

public Execution.Builder clearResult()

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
Execution.Builder

This builder for chaining.

clearStartTime()

public Execution.Builder clearStartTime()

Output only. Marks the beginning of execution.

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

Returns
Type Description
Execution.Builder

clearState()

public Execution.Builder clearState()

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.Builder

This builder for chaining.

clearWorkflowRevisionId()

public Execution.Builder clearWorkflowRevisionId()

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

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

Returns
Type Description
Execution.Builder

This builder for chaining.

clone()

public Execution.Builder clone()
Returns
Type Description
Execution.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

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.

getErrorBuilder()

public Execution.Error.Builder getErrorBuilder()

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.Builder

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.

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.

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. Marks the beginning of execution.

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

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public Execution.Builder mergeEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

mergeError(Execution.Error value)

public Execution.Builder mergeError(Execution.Error value)

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

Parameter
Name Description
value Execution.Error
Returns
Type Description
Execution.Builder

mergeFrom(Execution other)

public Execution.Builder mergeFrom(Execution other)
Parameter
Name Description
other Execution
Returns
Type Description
Execution.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Execution.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Execution.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Execution.Builder
Overrides

mergeStartTime(Timestamp value)

public Execution.Builder mergeStartTime(Timestamp value)

Output only. Marks the beginning of execution.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Execution.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Execution.Builder
Overrides

setArgument(String value)

public Execution.Builder setArgument(String value)

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

string argument = 5;

Parameter
Name Description
value String

The argument to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setArgumentBytes(ByteString value)

public Execution.Builder setArgumentBytes(ByteString value)

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

string argument = 5;

Parameter
Name Description
value ByteString

The bytes for argument to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setEndTime(Timestamp value)

public Execution.Builder setEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

setEndTime(Timestamp.Builder builderForValue)

public Execution.Builder setEndTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Execution.Builder

setError(Execution.Error value)

public Execution.Builder setError(Execution.Error value)

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

Parameter
Name Description
value Execution.Error
Returns
Type Description
Execution.Builder

setError(Execution.Error.Builder builderForValue)

public Execution.Builder setError(Execution.Error.Builder builderForValue)

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

Parameter
Name Description
builderForValue Execution.Error.Builder
Returns
Type Description
Execution.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Execution.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Execution.Builder
Overrides

setName(String value)

public Execution.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Execution.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Execution.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Execution.Builder
Overrides

setResult(String value)

public Execution.Builder setResult(String value)

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

Parameter
Name Description
value String

The result to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setResultBytes(ByteString value)

public Execution.Builder setResultBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for result to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setStartTime(Timestamp value)

public Execution.Builder setStartTime(Timestamp value)

Output only. Marks the beginning of execution.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

setStartTime(Timestamp.Builder builderForValue)

public Execution.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. Marks the beginning of execution.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Execution.Builder

setState(Execution.State value)

public Execution.Builder setState(Execution.State value)

Output only. Current state of the execution.

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

Parameter
Name Description
value Execution.State

The state to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setStateValue(int value)

public Execution.Builder setStateValue(int value)

Output only. Current state of the execution.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Execution.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Execution.Builder
Overrides

setWorkflowRevisionId(String value)

public Execution.Builder setWorkflowRevisionId(String value)

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

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

Parameter
Name Description
value String

The workflowRevisionId to set.
Returns
Type Description
Execution.Builder

This builder for chaining.

setWorkflowRevisionIdBytes(ByteString value)

public Execution.Builder setWorkflowRevisionIdBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for workflowRevisionId to set.
Returns
Type Description
Execution.Builder

This builder for chaining.