- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.1
- 2.1.7
public static final class Execution.Builder extends GeneratedMessageV3.Builder<Execution.Builder> implements ExecutionOrBuilderA running instance of a Workflow.
Protobuf type google.cloud.workflows.executions.v1.Execution
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Execution.BuilderImplements
ExecutionOrBuilderStatic 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 | |
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 | |
clearArgument()
public Execution.Builder clearArgument()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 |
Execution.Builder | This builder for chaining. |
clearCallLogLevel()
public Execution.Builder clearCallLogLevel()The call logging level associated to this execution.
.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |
clearDuration()
public Execution.Builder clearDuration()Output only. Measures the duration of the execution.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
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.v1.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 | |
clearLabels()
public Execution.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
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 | |
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.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |
clearStateError()
public Execution.Builder clearStateError()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.Builder | |
clearStatus()
public Execution.Builder clearStatus()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.Builder | |
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 | |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for callLogLevel. |
getDefaultInstanceForType()
public Execution getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Execution | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDuration()
public Duration getDuration()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. |
getDurationBuilder()
public Duration.Builder getDurationBuilder()Output only. Measures the duration of the execution.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getDurationOrBuilder()
public DurationOrBuilder getDurationOrBuilder()Output only. Measures the duration of the execution.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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.v1.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.v1.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.v1.Execution.Error error = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Execution.ErrorOrBuilder | |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,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 | |
|---|---|
| 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.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Execution.StateError | The stateError. |
getStateErrorBuilder()
public Execution.StateError.Builder getStateErrorBuilder()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.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Execution.Status | The status. |
getStatusBuilder()
public Execution.Status.Builder getStatusBuilder()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.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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. |
hasDuration()
public boolean hasDuration()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()
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.v1.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. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean | Whether the status field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
MapField | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeDuration(Duration value)
public Execution.Builder mergeDuration(Duration value)Output only. Measures the duration of the execution.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
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.v1.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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Execution.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
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 | |
mergeStateError(Execution.StateError value)
public Execution.Builder mergeStateError(Execution.StateError value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Execution.StateError |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
mergeStatus(Execution.Status value)
public Execution.Builder mergeStatus(Execution.Status value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Execution.Status |
| 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 | |
putAllLabels(Map<String,String> values)
public Execution.Builder putAllLabels(Map<String,String> values)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 |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
putLabels(String key, String value)
public Execution.Builder putLabels(String key, String value)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 |
value | String |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
removeLabels(String key)
public Execution.Builder removeLabels(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 | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
setArgument(String value)
public Execution.Builder setArgument(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe 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.
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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for argument to set. |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |
setCallLogLevel(Execution.CallLogLevel value)
public Execution.Builder setCallLogLevel(Execution.CallLogLevel value)The call logging level associated to this execution.
.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;
| Parameter | |
|---|---|
| Name | Description |
value | Execution.CallLogLevelThe callLogLevel to set. |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |
setCallLogLevelValue(int value)
public Execution.Builder setCallLogLevelValue(int value)The call logging level associated to this execution.
.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for callLogLevel to set. |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |
setDuration(Duration value)
public Execution.Builder setDuration(Duration value)Output only. Measures the duration of the execution.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
setDuration(Duration.Builder builderForValue)
public Execution.Builder setDuration(Duration.Builder builderForValue)Output only. Measures the duration of the execution.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
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.v1.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.v1.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 | |
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 | StringThe 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 | ByteStringThe 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 | |
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 | StringThe 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 | ByteStringThe 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.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Execution.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |
setStateError(Execution.StateError value)
public Execution.Builder setStateError(Execution.StateError value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Execution.StateError |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
setStateError(Execution.StateError.Builder builderForValue)
public Execution.Builder setStateError(Execution.StateError.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Execution.StateError.Builder |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
setStateValue(int value)
public Execution.Builder setStateValue(int value)Output only. Current state of the execution.
.google.cloud.workflows.executions.v1.Execution.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |
setStatus(Execution.Status value)
public Execution.Builder setStatus(Execution.Status value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Execution.Status |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
setStatus(Execution.Status.Builder builderForValue)
public Execution.Builder setStatus(Execution.Status.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Execution.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Execution.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | |
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 | StringThe 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 | ByteStringThe bytes for workflowRevisionId to set. |
| Returns | |
|---|---|
| Type | Description |
Execution.Builder | This builder for chaining. |