com.google.cloud.workflows.executions.v1

Class Execution

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.workflows.executions.v1.Execution

All Implemented Interfaces:

ExecutionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Execution
extends com.google.protobuf.GeneratedMessageV3
implements ExecutionOrBuilder

 A running instance of a
 [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows).
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Execution.Builder A running instance of a [Workflow](/workflows/docs/reference/rest/v1/projects.locations.workflows).
static class	Execution.CallLogLevel Describes the level of platform logging to apply to calls and call responses during workflow executions.
static class	Execution.Error Error describes why the execution was abnormally terminated.
static interface	Execution.ErrorOrBuilder
static class	Execution.StackTrace A collection of stack elements (frames) where an error occurred.
static class	Execution.StackTraceElement A single stack element (frame) where an error occurred.
static interface	Execution.StackTraceElementOrBuilder
static interface	Execution.StackTraceOrBuilder
static class	Execution.State Describes the current state of the execution.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARGUMENT_FIELD_NUMBER
static int	CALL_LOG_LEVEL_FIELD_NUMBER
static int	END_TIME_FIELD_NUMBER
static int	ERROR_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	RESULT_FIELD_NUMBER
static int	START_TIME_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	WORKFLOW_REVISION_ID_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getArgument() Input parameters of the execution represented as a JSON string.
com.google.protobuf.ByteString	getArgumentBytes() Input parameters of the execution represented as a JSON string.
Execution.CallLogLevel	getCallLogLevel() The call logging level associated to this execution.
int	getCallLogLevelValue() The call logging level associated to this execution.
static Execution	getDefaultInstance()
Execution	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Timestamp	getEndTime() Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Output only.
Execution.Error	getError() Output only.
Execution.ErrorOrBuilder	getErrorOrBuilder() Output only.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Parser<Execution>	getParserForType()
String	getResult() Output only.
com.google.protobuf.ByteString	getResultBytes() Output only.
int	getSerializedSize()
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
Execution.State	getState() Output only.
int	getStateValue() Output only.
String	getWorkflowRevisionId() Output only.
com.google.protobuf.ByteString	getWorkflowRevisionIdBytes() Output only.
boolean	hasEndTime() Output only.
boolean	hasError() Output only.
int	hashCode()
boolean	hasStartTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Execution.Builder	newBuilder()
static Execution.Builder	newBuilder(Execution prototype)
Execution.Builder	newBuilderForType()
protected Execution.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Execution	parseDelimitedFrom(InputStream input)
static Execution	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Execution	parseFrom(byte[] data)
static Execution	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Execution	parseFrom(ByteBuffer data)
static Execution	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Execution	parseFrom(com.google.protobuf.ByteString data)
static Execution	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Execution	parseFrom(com.google.protobuf.CodedInputStream input)
static Execution	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Execution	parseFrom(InputStream input)
static Execution	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Execution>	parser()
Execution.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

ARGUMENT_FIELD_NUMBER

public static final int ARGUMENT_FIELD_NUMBER

See Also:

Constant Field Values

RESULT_FIELD_NUMBER

public static final int RESULT_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

See Also:

Constant Field Values

WORKFLOW_REVISION_ID_FIELD_NUMBER

public static final int WORKFLOW_REVISION_ID_FIELD_NUMBER

See Also:

Constant Field Values

CALL_LOG_LEVEL_FIELD_NUMBER

public static final int CALL_LOG_LEVEL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

Specified by:

getName in interface ExecutionOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.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];

Specified by:

getNameBytes in interface ExecutionOrBuilder

Returns:

The bytes for name.

hasStartTime

public boolean hasStartTime()

 Output only. Marks the beginning of execution.
 

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

Specified by:

hasStartTime in interface ExecutionOrBuilder

Returns:

Whether the startTime field is set.

getStartTime

public com.google.protobuf.Timestamp getStartTime()

 Output only. Marks the beginning of execution.
 

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

Specified by:

getStartTime in interface ExecutionOrBuilder

Returns:

The startTime.

getStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. Marks the beginning of execution.
 

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

Specified by:

getStartTimeOrBuilder in interface ExecutionOrBuilder

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

Specified by:

hasEndTime in interface ExecutionOrBuilder

Returns:

Whether the endTime field is set.

getEndTime

public com.google.protobuf.Timestamp getEndTime()

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

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

Specified by:

getEndTime in interface ExecutionOrBuilder

Returns:

The endTime.

getEndTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

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

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

Specified by:

getEndTimeOrBuilder in interface ExecutionOrBuilder

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

Specified by:

getStateValue in interface ExecutionOrBuilder

Returns:

The enum numeric value on the wire for state.

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

Specified by:

getState in interface ExecutionOrBuilder

Returns:

The state.

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;

Specified by:

getArgument in interface ExecutionOrBuilder

Returns:

The argument.

getArgumentBytes

public com.google.protobuf.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;

Specified by:

getArgumentBytes in interface ExecutionOrBuilder

Returns:

The bytes for argument.

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

Specified by:

getResult in interface ExecutionOrBuilder

Returns:

The result.

getResultBytes

public com.google.protobuf.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];

Specified by:

getResultBytes in interface ExecutionOrBuilder

Returns:

The bytes for result.

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

Specified by:

hasError in interface ExecutionOrBuilder

Returns:

Whether the error field is set.

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

Specified by:

getError in interface ExecutionOrBuilder

Returns:

The error.

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

Specified by:

getErrorOrBuilder in interface ExecutionOrBuilder

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

Specified by:

getWorkflowRevisionId in interface ExecutionOrBuilder

Returns:

The workflowRevisionId.

getWorkflowRevisionIdBytes

public com.google.protobuf.ByteString getWorkflowRevisionIdBytes()

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

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

Specified by:

getWorkflowRevisionIdBytes in interface ExecutionOrBuilder

Returns:

The bytes for workflowRevisionId.

getCallLogLevelValue

public int getCallLogLevelValue()

 The call logging level associated to this execution.
 

.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;

Specified by:

getCallLogLevelValue in interface ExecutionOrBuilder

Returns:

The enum numeric value on the wire for callLogLevel.

getCallLogLevel

public Execution.CallLogLevel getCallLogLevel()

 The call logging level associated to this execution.
 

.google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9;

Specified by:

getCallLogLevel in interface ExecutionOrBuilder

Returns:

The callLogLevel.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Execution parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Execution parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Execution parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Execution parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Execution parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Execution parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Execution parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static Execution parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Execution parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static Execution parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static Execution parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static Execution parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public Execution.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Execution.Builder newBuilder()

newBuilder

public static Execution.Builder newBuilder(Execution prototype)

toBuilder

public Execution.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Execution.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Execution getDefaultInstance()

parser

public static com.google.protobuf.Parser<Execution> parser()

getParserForType

public com.google.protobuf.Parser<Execution> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Execution getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder