Interface ExecutionOrBuilder (2.32.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 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
publicinterface ExecutionOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
publicabstractbooleancontainsLabels(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 |
|
getArgument()
publicabstractStringgetArgument()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()
publicabstractByteStringgetArgumentBytes()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()
publicabstractExecution.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()
publicabstractintgetCallLogLevelValue()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. |
getDuration()
publicabstractDurationgetDuration()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()
publicabstractDurationOrBuildergetDurationOrBuilder()Output only. Measures the duration of the execution.
.google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getEndTime()
publicabstractTimestampgetEndTime()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()
publicabstractTimestampOrBuildergetEndTimeOrBuilder()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()
publicabstractExecution.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()
publicabstractExecution.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)
publicabstractMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicabstractintgetLabelsCount()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()
publicabstractMap<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)
publicabstractStringgetLabelsOrDefault(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)
publicabstractStringgetLabelsOrThrow(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()
publicabstractStringgetName()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()
publicabstractByteStringgetNameBytes()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()
publicabstractStringgetResult() 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()
publicabstractByteStringgetResultBytes() 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()
publicabstractTimestampgetStartTime()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()
publicabstractTimestampOrBuildergetStartTimeOrBuilder()Output only. Marks the beginning of execution.
.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getState()
publicabstractExecution.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()
publicabstractExecution.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()
publicabstractExecution.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()
publicabstractintgetStateValue()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()
publicabstractExecution.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()
publicabstractExecution.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()
publicabstractStringgetWorkflowRevisionId()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()
publicabstractByteStringgetWorkflowRevisionIdBytes()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()
publicabstractbooleanhasDuration()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()
publicabstractbooleanhasEndTime()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()
publicabstractbooleanhasError() 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()
publicabstractbooleanhasStartTime()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()
publicabstractbooleanhasStateError()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()
publicabstractbooleanhasStatus()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. |