public final class Execution extends GeneratedMessageV3 implements ExecutionOrBuilder
A running instance of a
Workflow.
Protobuf type google.cloud.workflows.executions.v1.Execution
Static Fields
ARGUMENT_FIELD_NUMBER
public static final int ARGUMENT_FIELD_NUMBER
Field Value
CALL_LOG_LEVEL_FIELD_NUMBER
public static final int CALL_LOG_LEVEL_FIELD_NUMBER
Field Value
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER
Field Value
ERROR_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESULT_FIELD_NUMBER
public static final int RESULT_FIELD_NUMBER
Field Value
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
WORKFLOW_REVISION_ID_FIELD_NUMBER
public static final int WORKFLOW_REVISION_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Execution getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Execution.Builder newBuilder()
Returns
newBuilder(Execution prototype)
public static Execution.Builder newBuilder(Execution prototype)
Parameter
Returns
public static Execution parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Execution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Execution parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Execution parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Execution parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Execution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Execution parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Execution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Execution parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Execution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Execution> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| 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;
getCallLogLevel()
public Execution.CallLogLevel getCallLogLevel()
The call logging level associated to this execution.
.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;
getCallLogLevelValue()
public int getCallLogLevelValue()
The call logging level associated to this execution.
.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;
| Type | Description |
| int | The enum numeric value on the wire for callLogLevel.
|
getDefaultInstanceForType()
public Execution getDefaultInstanceForType()
Returns
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];
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];
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];
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];
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];
| 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];
getParserForType()
public Parser<Execution> getParserForType()
Returns
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];
| 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStartTime()
public Timestamp getStartTime()
Output only. Marks the beginning of execution.
.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. Marks the beginning of execution.
.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| 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];
| 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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the startTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Execution.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Execution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Execution.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
