Interface ExecutionOrBuilder (2.5.0)

Version 2.5.0

• 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 interface ExecutionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArgument()

public abstract 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 abstract 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 abstract 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 abstract 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.

getEndTime()

public abstract 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 abstract 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 abstract 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.

getErrorOrBuilder()

public abstract 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

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getStateValue()

public abstract 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.

getWorkflowRevisionId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.