Class WorkflowExecutionStartedEventAttributes
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,WorkflowExecutionStartedEventAttributesOrBuilder,Serializable
@Generated(value="protoc",
comments="annotations:WorkflowExecutionStartedEventAttributes.java.pb.meta")
public final class WorkflowExecutionStartedEventAttributes
extends com.google.protobuf.GeneratedMessageV3
implements WorkflowExecutionStartedEventAttributesOrBuilder
Always the first event in workflow historyProtobuf type
temporal.api.history.v1.WorkflowExecutionStartedEventAttributes- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAlways the first event in workflow historyNested 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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanintStarting at 1, the number of times we have tried to execute this workflowgetCompletionCallbacks(int index) Completion callbacks attached when this workflow was started.intCompletion callbacks attached when this workflow was started.Completion callbacks attached when this workflow was started.getCompletionCallbacksOrBuilder(int index) Completion callbacks attached when this workflow was started.List<? extends CallbackOrBuilder> Completion callbacks attached when this workflow was started.Run id of the previous workflow which continued-as-new or retried or cron executed into this workflow.com.google.protobuf.ByteStringRun id of the previous workflow which continued-as-new or retried or cron executed into this workflow..temporal.api.failure.v1.Failure continued_failure = 12;.temporal.api.failure.v1.Failure continued_failure = 12;If this workflow runs on a cron schedule, it will appear herecom.google.protobuf.ByteStringIf this workflow runs on a cron schedule, it will appear hereDuring a previous run of this workflow, the server may have notified the SDK that the Target Worker Deployment Version changed, but the SDK declined to upgrade (e.g., by continuing-as-new with PINNED behavior).During a previous run of this workflow, the server may have notified the SDK that the Target Worker Deployment Version changed, but the SDK declined to upgrade (e.g., by continuing-as-new with PINNED behavior).static final com.google.protobuf.Descriptors.DescriptorbooleanA boolean indicating whether the SDK has asked to eagerly execute the first workflow task for this workflow and eager execution was accepted by the server.This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset.com.google.protobuf.ByteStringThis is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset.com.google.protobuf.DurationFor a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.com.google.protobuf.DurationOrBuilderFor a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule..temporal.api.common.v1.Header header = 25;.temporal.api.common.v1.Header header = 25;Identity of the client who requested this executioncom.google.protobuf.ByteStringIdentity of the client who requested this executionIf present, the new workflow begins with AutoUpgrade behavior.If present, the new workflow begins with AutoUpgrade behavior.Deprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.inherited_build_id is deprecated.com.google.protobuf.ByteStringDeprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.inherited_build_id is deprecated.If present, the new workflow should start on this version with pinned base behavior.If present, the new workflow should start on this version with pinned base behavior..temporal.api.enums.v1.ContinueAsNewInitiator initiator = 11;int.temporal.api.enums.v1.ContinueAsNewInitiator initiator = 11;getInput()SDK will deserialize this and provide it as arguments to the workflow functionSDK will deserialize this and provide it as arguments to the workflow function.temporal.api.common.v1.Payloads last_completion_result = 13;.temporal.api.common.v1.Payloads last_completion_result = 13;getMemo().temporal.api.common.v1.Memo memo = 22;.temporal.api.common.v1.Memo memo = 22;This is the run id when the WorkflowExecutionStarted event was written.com.google.protobuf.ByteStringThis is the run id when the WorkflowExecutionStarted event was written.longEventID of the child execution initiated event in parent workflowlongVersion of the child execution initiated event in parent workflow It should be used together with parent_initiated_event_id to identify a child initiated event for global namespaceDeprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.parent_pinned_worker_deployment_version is deprecated.com.google.protobuf.ByteStringDeprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.parent_pinned_worker_deployment_version is deprecated.Contains information about parent workflow execution that initiated the child workflow these attributes belong to.Contains information about parent workflow execution that initiated the child workflow these attributes belong to.If this workflow is a child, the namespace our parent lives in.com.google.protobuf.ByteStringIf this workflow is a child, the namespace our parent lives in.string parent_workflow_namespace_id = 27;com.google.protobuf.ByteStringstring parent_workflow_namespace_id = 27;com.google.protobuf.Parser<WorkflowExecutionStartedEventAttributes> .temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;.temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;Priority metadataPriority metadata.temporal.api.common.v1.RetryPolicy retry_policy = 17;.temporal.api.common.v1.RetryPolicy retry_policy = 17;Contains information about the root workflow execution.Contains information about the root workflow execution..temporal.api.common.v1.SearchAttributes search_attributes = 23;.temporal.api.common.v1.SearchAttributes search_attributes = 23;intDeprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.source_version_stamp is deprecated.Deprecated..temporal.api.taskqueue.v1.TaskQueue task_queue = 5;.temporal.api.taskqueue.v1.TaskQueue task_queue = 5;Initial time-skipping configuration for this workflow execution, recorded at start time.Initial time-skipping configuration for this workflow execution, recorded at start time.The time-skipping state propagated from a previous run of this workflow.The time-skipping state propagated from a previous run of this workflow.Versioning override applied to this workflow when it was started.Versioning override applied to this workflow when it was started.com.google.protobuf.TimestampThe absolute time at which the workflow will be timed out.com.google.protobuf.TimestampOrBuilderThe absolute time at which the workflow will be timed out.com.google.protobuf.DurationTotal workflow execution timeout including retries and continue as new.com.google.protobuf.DurationOrBuilderTotal workflow execution timeout including retries and continue as new.This field is new in 1.21.com.google.protobuf.ByteStringThis field is new in 1.21.com.google.protobuf.DurationTimeout of a single workflow run.com.google.protobuf.DurationOrBuilderTimeout of a single workflow run.com.google.protobuf.DurationTimeout of a single workflow task.com.google.protobuf.DurationOrBuilderTimeout of a single workflow task..temporal.api.common.v1.WorkflowType workflow_type = 1;.temporal.api.common.v1.WorkflowType workflow_type = 1;boolean.temporal.api.failure.v1.Failure continued_failure = 12;booleanDuring a previous run of this workflow, the server may have notified the SDK that the Target Worker Deployment Version changed, but the SDK declined to upgrade (e.g., by continuing-as-new with PINNED behavior).booleanFor a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.inthashCode()boolean.temporal.api.common.v1.Header header = 25;booleanIf present, the new workflow begins with AutoUpgrade behavior.booleanIf present, the new workflow should start on this version with pinned base behavior.booleanhasInput()SDK will deserialize this and provide it as arguments to the workflow functionboolean.temporal.api.common.v1.Payloads last_completion_result = 13;booleanhasMemo().temporal.api.common.v1.Memo memo = 22;booleanContains information about parent workflow execution that initiated the child workflow these attributes belong to.boolean.temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;booleanPriority metadataboolean.temporal.api.common.v1.RetryPolicy retry_policy = 17;booleanContains information about the root workflow execution.boolean.temporal.api.common.v1.SearchAttributes search_attributes = 23;booleanDeprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.source_version_stamp is deprecated.boolean.temporal.api.taskqueue.v1.TaskQueue task_queue = 5;booleanInitial time-skipping configuration for this workflow execution, recorded at start time.booleanThe time-skipping state propagated from a previous run of this workflow.booleanVersioning override applied to this workflow when it was started.booleanThe absolute time at which the workflow will be timed out.booleanTotal workflow execution timeout including retries and continue as new.booleanTimeout of a single workflow run.booleanTimeout of a single workflow task.boolean.temporal.api.common.v1.WorkflowType workflow_type = 1;protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<WorkflowExecutionStartedEventAttributes> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
WORKFLOW_TYPE_FIELD_NUMBER
public static final int WORKFLOW_TYPE_FIELD_NUMBER- See Also:
-
PARENT_WORKFLOW_NAMESPACE_FIELD_NUMBER
public static final int PARENT_WORKFLOW_NAMESPACE_FIELD_NUMBER- See Also:
-
PARENT_WORKFLOW_NAMESPACE_ID_FIELD_NUMBER
public static final int PARENT_WORKFLOW_NAMESPACE_ID_FIELD_NUMBER- See Also:
-
PARENT_WORKFLOW_EXECUTION_FIELD_NUMBER
public static final int PARENT_WORKFLOW_EXECUTION_FIELD_NUMBER- See Also:
-
PARENT_INITIATED_EVENT_ID_FIELD_NUMBER
public static final int PARENT_INITIATED_EVENT_ID_FIELD_NUMBER- See Also:
-
TASK_QUEUE_FIELD_NUMBER
public static final int TASK_QUEUE_FIELD_NUMBER- See Also:
-
INPUT_FIELD_NUMBER
public static final int INPUT_FIELD_NUMBER- See Also:
-
WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER
public static final int WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER- See Also:
-
WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER
public static final int WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER- See Also:
-
WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER
public static final int WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER- See Also:
-
CONTINUED_EXECUTION_RUN_ID_FIELD_NUMBER
public static final int CONTINUED_EXECUTION_RUN_ID_FIELD_NUMBER- See Also:
-
INITIATOR_FIELD_NUMBER
public static final int INITIATOR_FIELD_NUMBER- See Also:
-
CONTINUED_FAILURE_FIELD_NUMBER
public static final int CONTINUED_FAILURE_FIELD_NUMBER- See Also:
-
LAST_COMPLETION_RESULT_FIELD_NUMBER
public static final int LAST_COMPLETION_RESULT_FIELD_NUMBER- See Also:
-
ORIGINAL_EXECUTION_RUN_ID_FIELD_NUMBER
public static final int ORIGINAL_EXECUTION_RUN_ID_FIELD_NUMBER- See Also:
-
IDENTITY_FIELD_NUMBER
public static final int IDENTITY_FIELD_NUMBER- See Also:
-
FIRST_EXECUTION_RUN_ID_FIELD_NUMBER
public static final int FIRST_EXECUTION_RUN_ID_FIELD_NUMBER- See Also:
-
RETRY_POLICY_FIELD_NUMBER
public static final int RETRY_POLICY_FIELD_NUMBER- See Also:
-
ATTEMPT_FIELD_NUMBER
public static final int ATTEMPT_FIELD_NUMBER- See Also:
-
WORKFLOW_EXECUTION_EXPIRATION_TIME_FIELD_NUMBER
public static final int WORKFLOW_EXECUTION_EXPIRATION_TIME_FIELD_NUMBER- See Also:
-
CRON_SCHEDULE_FIELD_NUMBER
public static final int CRON_SCHEDULE_FIELD_NUMBER- See Also:
-
FIRST_WORKFLOW_TASK_BACKOFF_FIELD_NUMBER
public static final int FIRST_WORKFLOW_TASK_BACKOFF_FIELD_NUMBER- See Also:
-
MEMO_FIELD_NUMBER
public static final int MEMO_FIELD_NUMBER- See Also:
-
SEARCH_ATTRIBUTES_FIELD_NUMBER
public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER- See Also:
-
PREV_AUTO_RESET_POINTS_FIELD_NUMBER
public static final int PREV_AUTO_RESET_POINTS_FIELD_NUMBER- See Also:
-
HEADER_FIELD_NUMBER
public static final int HEADER_FIELD_NUMBER- See Also:
-
PARENT_INITIATED_EVENT_VERSION_FIELD_NUMBER
public static final int PARENT_INITIATED_EVENT_VERSION_FIELD_NUMBER- See Also:
-
WORKFLOW_ID_FIELD_NUMBER
public static final int WORKFLOW_ID_FIELD_NUMBER- See Also:
-
SOURCE_VERSION_STAMP_FIELD_NUMBER
public static final int SOURCE_VERSION_STAMP_FIELD_NUMBER- See Also:
-
COMPLETION_CALLBACKS_FIELD_NUMBER
public static final int COMPLETION_CALLBACKS_FIELD_NUMBER- See Also:
-
ROOT_WORKFLOW_EXECUTION_FIELD_NUMBER
public static final int ROOT_WORKFLOW_EXECUTION_FIELD_NUMBER- See Also:
-
INHERITED_BUILD_ID_FIELD_NUMBER
public static final int INHERITED_BUILD_ID_FIELD_NUMBER- See Also:
-
VERSIONING_OVERRIDE_FIELD_NUMBER
public static final int VERSIONING_OVERRIDE_FIELD_NUMBER- See Also:
-
PARENT_PINNED_WORKER_DEPLOYMENT_VERSION_FIELD_NUMBER
public static final int PARENT_PINNED_WORKER_DEPLOYMENT_VERSION_FIELD_NUMBER- See Also:
-
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER- See Also:
-
INHERITED_PINNED_VERSION_FIELD_NUMBER
public static final int INHERITED_PINNED_VERSION_FIELD_NUMBER- See Also:
-
INHERITED_AUTO_UPGRADE_INFO_FIELD_NUMBER
public static final int INHERITED_AUTO_UPGRADE_INFO_FIELD_NUMBER- See Also:
-
EAGER_EXECUTION_ACCEPTED_FIELD_NUMBER
public static final int EAGER_EXECUTION_ACCEPTED_FIELD_NUMBER- See Also:
-
DECLINED_TARGET_VERSION_UPGRADE_FIELD_NUMBER
public static final int DECLINED_TARGET_VERSION_UPGRADE_FIELD_NUMBER- See Also:
-
TIME_SKIPPING_CONFIG_FIELD_NUMBER
public static final int TIME_SKIPPING_CONFIG_FIELD_NUMBER- See Also:
-
TIME_SKIPPING_STATE_PROPAGATION_FIELD_NUMBER
public static final int TIME_SKIPPING_STATE_PROPAGATION_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasWorkflowType
public boolean hasWorkflowType().temporal.api.common.v1.WorkflowType workflow_type = 1;- Specified by:
hasWorkflowTypein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the workflowType field is set.
-
getWorkflowType
.temporal.api.common.v1.WorkflowType workflow_type = 1;- Specified by:
getWorkflowTypein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The workflowType.
-
getWorkflowTypeOrBuilder
.temporal.api.common.v1.WorkflowType workflow_type = 1;- Specified by:
getWorkflowTypeOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getParentWorkflowNamespace
If this workflow is a child, the namespace our parent lives in. SDKs and UI tools should use `parent_workflow_namespace` field but server must use `parent_workflow_namespace_id` only.
string parent_workflow_namespace = 2;- Specified by:
getParentWorkflowNamespacein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The parentWorkflowNamespace.
-
getParentWorkflowNamespaceBytes
public com.google.protobuf.ByteString getParentWorkflowNamespaceBytes()If this workflow is a child, the namespace our parent lives in. SDKs and UI tools should use `parent_workflow_namespace` field but server must use `parent_workflow_namespace_id` only.
string parent_workflow_namespace = 2;- Specified by:
getParentWorkflowNamespaceBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for parentWorkflowNamespace.
-
getParentWorkflowNamespaceId
string parent_workflow_namespace_id = 27;- Specified by:
getParentWorkflowNamespaceIdin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The parentWorkflowNamespaceId.
-
getParentWorkflowNamespaceIdBytes
public com.google.protobuf.ByteString getParentWorkflowNamespaceIdBytes()string parent_workflow_namespace_id = 27;- Specified by:
getParentWorkflowNamespaceIdBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for parentWorkflowNamespaceId.
-
hasParentWorkflowExecution
public boolean hasParentWorkflowExecution()Contains information about parent workflow execution that initiated the child workflow these attributes belong to. If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.
.temporal.api.common.v1.WorkflowExecution parent_workflow_execution = 3;- Specified by:
hasParentWorkflowExecutionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the parentWorkflowExecution field is set.
-
getParentWorkflowExecution
Contains information about parent workflow execution that initiated the child workflow these attributes belong to. If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.
.temporal.api.common.v1.WorkflowExecution parent_workflow_execution = 3;- Specified by:
getParentWorkflowExecutionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The parentWorkflowExecution.
-
getParentWorkflowExecutionOrBuilder
Contains information about parent workflow execution that initiated the child workflow these attributes belong to. If the workflow these attributes belong to is not a child workflow of any other execution, this field will not be populated.
.temporal.api.common.v1.WorkflowExecution parent_workflow_execution = 3;- Specified by:
getParentWorkflowExecutionOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getParentInitiatedEventId
public long getParentInitiatedEventId()EventID of the child execution initiated event in parent workflow
int64 parent_initiated_event_id = 4;- Specified by:
getParentInitiatedEventIdin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The parentInitiatedEventId.
-
hasTaskQueue
public boolean hasTaskQueue().temporal.api.taskqueue.v1.TaskQueue task_queue = 5;- Specified by:
hasTaskQueuein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the taskQueue field is set.
-
getTaskQueue
.temporal.api.taskqueue.v1.TaskQueue task_queue = 5;- Specified by:
getTaskQueuein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The taskQueue.
-
getTaskQueueOrBuilder
.temporal.api.taskqueue.v1.TaskQueue task_queue = 5;- Specified by:
getTaskQueueOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasInput
public boolean hasInput()SDK will deserialize this and provide it as arguments to the workflow function
.temporal.api.common.v1.Payloads input = 6;- Specified by:
hasInputin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the input field is set.
-
getInput
SDK will deserialize this and provide it as arguments to the workflow function
.temporal.api.common.v1.Payloads input = 6;- Specified by:
getInputin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The input.
-
getInputOrBuilder
SDK will deserialize this and provide it as arguments to the workflow function
.temporal.api.common.v1.Payloads input = 6;- Specified by:
getInputOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasWorkflowExecutionTimeout
public boolean hasWorkflowExecutionTimeout()Total workflow execution timeout including retries and continue as new.
.google.protobuf.Duration workflow_execution_timeout = 7;- Specified by:
hasWorkflowExecutionTimeoutin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the workflowExecutionTimeout field is set.
-
getWorkflowExecutionTimeout
public com.google.protobuf.Duration getWorkflowExecutionTimeout()Total workflow execution timeout including retries and continue as new.
.google.protobuf.Duration workflow_execution_timeout = 7;- Specified by:
getWorkflowExecutionTimeoutin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The workflowExecutionTimeout.
-
getWorkflowExecutionTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getWorkflowExecutionTimeoutOrBuilder()Total workflow execution timeout including retries and continue as new.
.google.protobuf.Duration workflow_execution_timeout = 7;- Specified by:
getWorkflowExecutionTimeoutOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasWorkflowRunTimeout
public boolean hasWorkflowRunTimeout()Timeout of a single workflow run.
.google.protobuf.Duration workflow_run_timeout = 8;- Specified by:
hasWorkflowRunTimeoutin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the workflowRunTimeout field is set.
-
getWorkflowRunTimeout
public com.google.protobuf.Duration getWorkflowRunTimeout()Timeout of a single workflow run.
.google.protobuf.Duration workflow_run_timeout = 8;- Specified by:
getWorkflowRunTimeoutin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The workflowRunTimeout.
-
getWorkflowRunTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getWorkflowRunTimeoutOrBuilder()Timeout of a single workflow run.
.google.protobuf.Duration workflow_run_timeout = 8;- Specified by:
getWorkflowRunTimeoutOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasWorkflowTaskTimeout
public boolean hasWorkflowTaskTimeout()Timeout of a single workflow task.
.google.protobuf.Duration workflow_task_timeout = 9;- Specified by:
hasWorkflowTaskTimeoutin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the workflowTaskTimeout field is set.
-
getWorkflowTaskTimeout
public com.google.protobuf.Duration getWorkflowTaskTimeout()Timeout of a single workflow task.
.google.protobuf.Duration workflow_task_timeout = 9;- Specified by:
getWorkflowTaskTimeoutin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The workflowTaskTimeout.
-
getWorkflowTaskTimeoutOrBuilder
public com.google.protobuf.DurationOrBuilder getWorkflowTaskTimeoutOrBuilder()Timeout of a single workflow task.
.google.protobuf.Duration workflow_task_timeout = 9;- Specified by:
getWorkflowTaskTimeoutOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getContinuedExecutionRunId
Run id of the previous workflow which continued-as-new or retried or cron executed into this workflow.
string continued_execution_run_id = 10;- Specified by:
getContinuedExecutionRunIdin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The continuedExecutionRunId.
-
getContinuedExecutionRunIdBytes
public com.google.protobuf.ByteString getContinuedExecutionRunIdBytes()Run id of the previous workflow which continued-as-new or retried or cron executed into this workflow.
string continued_execution_run_id = 10;- Specified by:
getContinuedExecutionRunIdBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for continuedExecutionRunId.
-
getInitiatorValue
public int getInitiatorValue().temporal.api.enums.v1.ContinueAsNewInitiator initiator = 11;- Specified by:
getInitiatorValuein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The enum numeric value on the wire for initiator.
-
getInitiator
.temporal.api.enums.v1.ContinueAsNewInitiator initiator = 11;- Specified by:
getInitiatorin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The initiator.
-
hasContinuedFailure
public boolean hasContinuedFailure().temporal.api.failure.v1.Failure continued_failure = 12;- Specified by:
hasContinuedFailurein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the continuedFailure field is set.
-
getContinuedFailure
.temporal.api.failure.v1.Failure continued_failure = 12;- Specified by:
getContinuedFailurein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The continuedFailure.
-
getContinuedFailureOrBuilder
.temporal.api.failure.v1.Failure continued_failure = 12;- Specified by:
getContinuedFailureOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasLastCompletionResult
public boolean hasLastCompletionResult().temporal.api.common.v1.Payloads last_completion_result = 13;- Specified by:
hasLastCompletionResultin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the lastCompletionResult field is set.
-
getLastCompletionResult
.temporal.api.common.v1.Payloads last_completion_result = 13;- Specified by:
getLastCompletionResultin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The lastCompletionResult.
-
getLastCompletionResultOrBuilder
.temporal.api.common.v1.Payloads last_completion_result = 13;- Specified by:
getLastCompletionResultOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getOriginalExecutionRunId
This is the run id when the WorkflowExecutionStarted event was written. A workflow reset changes the execution run_id, but preserves this field.
string original_execution_run_id = 14;- Specified by:
getOriginalExecutionRunIdin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The originalExecutionRunId.
-
getOriginalExecutionRunIdBytes
public com.google.protobuf.ByteString getOriginalExecutionRunIdBytes()This is the run id when the WorkflowExecutionStarted event was written. A workflow reset changes the execution run_id, but preserves this field.
string original_execution_run_id = 14;- Specified by:
getOriginalExecutionRunIdBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for originalExecutionRunId.
-
getIdentity
Identity of the client who requested this execution
string identity = 15;- Specified by:
getIdentityin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The identity.
-
getIdentityBytes
public com.google.protobuf.ByteString getIdentityBytes()Identity of the client who requested this execution
string identity = 15;- Specified by:
getIdentityBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for identity.
-
getFirstExecutionRunId
This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset. Used to identify a chain.
string first_execution_run_id = 16;- Specified by:
getFirstExecutionRunIdin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The firstExecutionRunId.
-
getFirstExecutionRunIdBytes
public com.google.protobuf.ByteString getFirstExecutionRunIdBytes()This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset. Used to identify a chain.
string first_execution_run_id = 16;- Specified by:
getFirstExecutionRunIdBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for firstExecutionRunId.
-
hasRetryPolicy
public boolean hasRetryPolicy().temporal.api.common.v1.RetryPolicy retry_policy = 17;- Specified by:
hasRetryPolicyin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the retryPolicy field is set.
-
getRetryPolicy
.temporal.api.common.v1.RetryPolicy retry_policy = 17;- Specified by:
getRetryPolicyin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The retryPolicy.
-
getRetryPolicyOrBuilder
.temporal.api.common.v1.RetryPolicy retry_policy = 17;- Specified by:
getRetryPolicyOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getAttempt
public int getAttempt()Starting at 1, the number of times we have tried to execute this workflow
int32 attempt = 18;- Specified by:
getAttemptin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The attempt.
-
hasWorkflowExecutionExpirationTime
public boolean hasWorkflowExecutionExpirationTime()The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.
.google.protobuf.Timestamp workflow_execution_expiration_time = 19;- Specified by:
hasWorkflowExecutionExpirationTimein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the workflowExecutionExpirationTime field is set.
-
getWorkflowExecutionExpirationTime
public com.google.protobuf.Timestamp getWorkflowExecutionExpirationTime()The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.
.google.protobuf.Timestamp workflow_execution_expiration_time = 19;- Specified by:
getWorkflowExecutionExpirationTimein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The workflowExecutionExpirationTime.
-
getWorkflowExecutionExpirationTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getWorkflowExecutionExpirationTimeOrBuilder()The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.
.google.protobuf.Timestamp workflow_execution_expiration_time = 19;- Specified by:
getWorkflowExecutionExpirationTimeOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getCronSchedule
If this workflow runs on a cron schedule, it will appear here
string cron_schedule = 20;- Specified by:
getCronSchedulein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The cronSchedule.
-
getCronScheduleBytes
public com.google.protobuf.ByteString getCronScheduleBytes()If this workflow runs on a cron schedule, it will appear here
string cron_schedule = 20;- Specified by:
getCronScheduleBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for cronSchedule.
-
hasFirstWorkflowTaskBackoff
public boolean hasFirstWorkflowTaskBackoff()For a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.
.google.protobuf.Duration first_workflow_task_backoff = 21;- Specified by:
hasFirstWorkflowTaskBackoffin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the firstWorkflowTaskBackoff field is set.
-
getFirstWorkflowTaskBackoff
public com.google.protobuf.Duration getFirstWorkflowTaskBackoff()For a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.
.google.protobuf.Duration first_workflow_task_backoff = 21;- Specified by:
getFirstWorkflowTaskBackoffin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The firstWorkflowTaskBackoff.
-
getFirstWorkflowTaskBackoffOrBuilder
public com.google.protobuf.DurationOrBuilder getFirstWorkflowTaskBackoffOrBuilder()For a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.
.google.protobuf.Duration first_workflow_task_backoff = 21;- Specified by:
getFirstWorkflowTaskBackoffOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasMemo
public boolean hasMemo().temporal.api.common.v1.Memo memo = 22;- Specified by:
hasMemoin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the memo field is set.
-
getMemo
.temporal.api.common.v1.Memo memo = 22;- Specified by:
getMemoin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The memo.
-
getMemoOrBuilder
.temporal.api.common.v1.Memo memo = 22;- Specified by:
getMemoOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasSearchAttributes
public boolean hasSearchAttributes().temporal.api.common.v1.SearchAttributes search_attributes = 23;- Specified by:
hasSearchAttributesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the searchAttributes field is set.
-
getSearchAttributes
.temporal.api.common.v1.SearchAttributes search_attributes = 23;- Specified by:
getSearchAttributesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The searchAttributes.
-
getSearchAttributesOrBuilder
.temporal.api.common.v1.SearchAttributes search_attributes = 23;- Specified by:
getSearchAttributesOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasPrevAutoResetPoints
public boolean hasPrevAutoResetPoints().temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;- Specified by:
hasPrevAutoResetPointsin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the prevAutoResetPoints field is set.
-
getPrevAutoResetPoints
.temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;- Specified by:
getPrevAutoResetPointsin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The prevAutoResetPoints.
-
getPrevAutoResetPointsOrBuilder
.temporal.api.workflow.v1.ResetPoints prev_auto_reset_points = 24;- Specified by:
getPrevAutoResetPointsOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasHeader
public boolean hasHeader().temporal.api.common.v1.Header header = 25;- Specified by:
hasHeaderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the header field is set.
-
getHeader
.temporal.api.common.v1.Header header = 25;- Specified by:
getHeaderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The header.
-
getHeaderOrBuilder
.temporal.api.common.v1.Header header = 25;- Specified by:
getHeaderOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getParentInitiatedEventVersion
public long getParentInitiatedEventVersion()Version of the child execution initiated event in parent workflow It should be used together with parent_initiated_event_id to identify a child initiated event for global namespace
int64 parent_initiated_event_version = 26;- Specified by:
getParentInitiatedEventVersionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The parentInitiatedEventVersion.
-
getWorkflowId
This field is new in 1.21.
string workflow_id = 28;- Specified by:
getWorkflowIdin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The workflowId.
-
getWorkflowIdBytes
public com.google.protobuf.ByteString getWorkflowIdBytes()This field is new in 1.21.
string workflow_id = 28;- Specified by:
getWorkflowIdBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for workflowId.
-
hasSourceVersionStamp
Deprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.source_version_stamp is deprecated. See temporal/api/history/v1/message.proto;l=87If this workflow intends to use anything other than the current overall default version for the queue, then we include it here. Deprecated. [cleanup-experimental-wv]
.temporal.api.common.v1.WorkerVersionStamp source_version_stamp = 29 [deprecated = true];- Specified by:
hasSourceVersionStampin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the sourceVersionStamp field is set.
-
getSourceVersionStamp
Deprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.source_version_stamp is deprecated. See temporal/api/history/v1/message.proto;l=87If this workflow intends to use anything other than the current overall default version for the queue, then we include it here. Deprecated. [cleanup-experimental-wv]
.temporal.api.common.v1.WorkerVersionStamp source_version_stamp = 29 [deprecated = true];- Specified by:
getSourceVersionStampin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The sourceVersionStamp.
-
getSourceVersionStampOrBuilder
Deprecated.If this workflow intends to use anything other than the current overall default version for the queue, then we include it here. Deprecated. [cleanup-experimental-wv]
.temporal.api.common.v1.WorkerVersionStamp source_version_stamp = 29 [deprecated = true];- Specified by:
getSourceVersionStampOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getCompletionCallbacksList
Completion callbacks attached when this workflow was started.
repeated .temporal.api.common.v1.Callback completion_callbacks = 30;- Specified by:
getCompletionCallbacksListin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getCompletionCallbacksOrBuilderList
Completion callbacks attached when this workflow was started.
repeated .temporal.api.common.v1.Callback completion_callbacks = 30;- Specified by:
getCompletionCallbacksOrBuilderListin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getCompletionCallbacksCount
public int getCompletionCallbacksCount()Completion callbacks attached when this workflow was started.
repeated .temporal.api.common.v1.Callback completion_callbacks = 30;- Specified by:
getCompletionCallbacksCountin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getCompletionCallbacks
Completion callbacks attached when this workflow was started.
repeated .temporal.api.common.v1.Callback completion_callbacks = 30;- Specified by:
getCompletionCallbacksin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getCompletionCallbacksOrBuilder
Completion callbacks attached when this workflow was started.
repeated .temporal.api.common.v1.Callback completion_callbacks = 30;- Specified by:
getCompletionCallbacksOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasRootWorkflowExecution
public boolean hasRootWorkflowExecution()Contains information about the root workflow execution. The root workflow execution is defined as follows: 1. A workflow without parent workflow is its own root workflow. 2. A workflow that has a parent workflow has the same root workflow as its parent workflow. When the workflow is its own root workflow, then root_workflow_execution is nil. Note: workflows continued as new or reseted may or may not have parents, check examples below. Examples: Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3. - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3. - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 3: Workflow W1 continued as new W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2. - W1 and W2 have root_workflow_execution set to nil. Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3 - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 5: Workflow W1 is reseted, creating W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2. - W1 and W2 have root_workflow_execution set to nil..temporal.api.common.v1.WorkflowExecution root_workflow_execution = 31;- Specified by:
hasRootWorkflowExecutionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the rootWorkflowExecution field is set.
-
getRootWorkflowExecution
Contains information about the root workflow execution. The root workflow execution is defined as follows: 1. A workflow without parent workflow is its own root workflow. 2. A workflow that has a parent workflow has the same root workflow as its parent workflow. When the workflow is its own root workflow, then root_workflow_execution is nil. Note: workflows continued as new or reseted may or may not have parents, check examples below. Examples: Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3. - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3. - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 3: Workflow W1 continued as new W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2. - W1 and W2 have root_workflow_execution set to nil. Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3 - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 5: Workflow W1 is reseted, creating W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2. - W1 and W2 have root_workflow_execution set to nil..temporal.api.common.v1.WorkflowExecution root_workflow_execution = 31;- Specified by:
getRootWorkflowExecutionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The rootWorkflowExecution.
-
getRootWorkflowExecutionOrBuilder
Contains information about the root workflow execution. The root workflow execution is defined as follows: 1. A workflow without parent workflow is its own root workflow. 2. A workflow that has a parent workflow has the same root workflow as its parent workflow. When the workflow is its own root workflow, then root_workflow_execution is nil. Note: workflows continued as new or reseted may or may not have parents, check examples below. Examples: Scenario 1: Workflow W1 starts child workflow W2, and W2 starts child workflow W3. - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 2: Workflow W1 starts child workflow W2, and W2 continued as new W3. - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 3: Workflow W1 continued as new W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2. - W1 and W2 have root_workflow_execution set to nil. Scenario 4: Workflow W1 starts child workflow W2, and W2 is reseted, creating W3 - The root workflow of all three workflows is W1. - W1 has root_workflow_execution set to nil. - W2 and W3 have root_workflow_execution set to W1. Scenario 5: Workflow W1 is reseted, creating W2. - The root workflow of W1 is W1 and the root workflow of W2 is W2. - W1 and W2 have root_workflow_execution set to nil..temporal.api.common.v1.WorkflowExecution root_workflow_execution = 31;- Specified by:
getRootWorkflowExecutionOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getInheritedBuildId
Deprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.inherited_build_id is deprecated. See temporal/api/history/v1/message.proto;l=120When present, this execution is assigned to the build ID of its parent or previous execution. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
string inherited_build_id = 32 [deprecated = true];- Specified by:
getInheritedBuildIdin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The inheritedBuildId.
-
getInheritedBuildIdBytes
Deprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.inherited_build_id is deprecated. See temporal/api/history/v1/message.proto;l=120When present, this execution is assigned to the build ID of its parent or previous execution. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
string inherited_build_id = 32 [deprecated = true];- Specified by:
getInheritedBuildIdBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for inheritedBuildId.
-
hasVersioningOverride
public boolean hasVersioningOverride()Versioning override applied to this workflow when it was started. Children, crons, retries, and continue-as-new will inherit source run's override if pinned and if the new workflow's Task Queue belongs to the override version.
.temporal.api.workflow.v1.VersioningOverride versioning_override = 33;- Specified by:
hasVersioningOverridein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the versioningOverride field is set.
-
getVersioningOverride
Versioning override applied to this workflow when it was started. Children, crons, retries, and continue-as-new will inherit source run's override if pinned and if the new workflow's Task Queue belongs to the override version.
.temporal.api.workflow.v1.VersioningOverride versioning_override = 33;- Specified by:
getVersioningOverridein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The versioningOverride.
-
getVersioningOverrideOrBuilder
Versioning override applied to this workflow when it was started. Children, crons, retries, and continue-as-new will inherit source run's override if pinned and if the new workflow's Task Queue belongs to the override version.
.temporal.api.workflow.v1.VersioningOverride versioning_override = 33;- Specified by:
getVersioningOverrideOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getParentPinnedWorkerDeploymentVersion
Deprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.parent_pinned_worker_deployment_version is deprecated. See temporal/api/history/v1/message.proto;l=131When present, it means this is a child workflow of a parent that is Pinned to this Worker Deployment Version. In this case, child workflow will start as Pinned to this Version instead of starting on the Current Version of its Task Queue. This is set only if the child workflow is starting on a Task Queue belonging to the same Worker Deployment Version. Deprecated. Use `parent_versioning_info`.
string parent_pinned_worker_deployment_version = 34 [deprecated = true];- Specified by:
getParentPinnedWorkerDeploymentVersionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The parentPinnedWorkerDeploymentVersion.
-
getParentPinnedWorkerDeploymentVersionBytes
Deprecated.temporal.api.history.v1.WorkflowExecutionStartedEventAttributes.parent_pinned_worker_deployment_version is deprecated. See temporal/api/history/v1/message.proto;l=131When present, it means this is a child workflow of a parent that is Pinned to this Worker Deployment Version. In this case, child workflow will start as Pinned to this Version instead of starting on the Current Version of its Task Queue. This is set only if the child workflow is starting on a Task Queue belonging to the same Worker Deployment Version. Deprecated. Use `parent_versioning_info`.
string parent_pinned_worker_deployment_version = 34 [deprecated = true];- Specified by:
getParentPinnedWorkerDeploymentVersionBytesin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The bytes for parentPinnedWorkerDeploymentVersion.
-
hasPriority
public boolean hasPriority()Priority metadata
.temporal.api.common.v1.Priority priority = 35;- Specified by:
hasPriorityin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the priority field is set.
-
getPriority
Priority metadata
.temporal.api.common.v1.Priority priority = 35;- Specified by:
getPriorityin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The priority.
-
getPriorityOrBuilder
Priority metadata
.temporal.api.common.v1.Priority priority = 35;- Specified by:
getPriorityOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasInheritedPinnedVersion
public boolean hasInheritedPinnedVersion()If present, the new workflow should start on this version with pinned base behavior. Child of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version. A new run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the new run's Task Queue belongs to that version. A new run initiated by workflow Cron will never inherit. A new run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time of retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned parent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version). Pinned override is inherited if Task Queue of new run is compatible with the override version. Override is inherited separately and takes precedence over inherited base version. Note: This field is mutually exclusive with inherited_auto_upgrade_info. Additionaly, versioning_override, if present, overrides this field during routing decisions.
.temporal.api.deployment.v1.WorkerDeploymentVersion inherited_pinned_version = 37;- Specified by:
hasInheritedPinnedVersionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the inheritedPinnedVersion field is set.
-
getInheritedPinnedVersion
If present, the new workflow should start on this version with pinned base behavior. Child of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version. A new run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the new run's Task Queue belongs to that version. A new run initiated by workflow Cron will never inherit. A new run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time of retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned parent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version). Pinned override is inherited if Task Queue of new run is compatible with the override version. Override is inherited separately and takes precedence over inherited base version. Note: This field is mutually exclusive with inherited_auto_upgrade_info. Additionaly, versioning_override, if present, overrides this field during routing decisions.
.temporal.api.deployment.v1.WorkerDeploymentVersion inherited_pinned_version = 37;- Specified by:
getInheritedPinnedVersionin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The inheritedPinnedVersion.
-
getInheritedPinnedVersionOrBuilder
If present, the new workflow should start on this version with pinned base behavior. Child of pinned parent will inherit the parent's version if the Child's Task Queue belongs to that version. A new run initiated by workflow ContinueAsNew of pinned run, will inherit the previous run's version if the new run's Task Queue belongs to that version. A new run initiated by workflow Cron will never inherit. A new run initiated by workflow Retry will only inherit if the retried run is effectively pinned at the time of retry, and the retried run inherited a pinned version when it started (ie. it is a child of a pinned parent, or a CaN of a pinned run, and is running on a Task Queue in the inherited version). Pinned override is inherited if Task Queue of new run is compatible with the override version. Override is inherited separately and takes precedence over inherited base version. Note: This field is mutually exclusive with inherited_auto_upgrade_info. Additionaly, versioning_override, if present, overrides this field during routing decisions.
.temporal.api.deployment.v1.WorkerDeploymentVersion inherited_pinned_version = 37;- Specified by:
getInheritedPinnedVersionOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasInheritedAutoUpgradeInfo
public boolean hasInheritedAutoUpgradeInfo()If present, the new workflow begins with AutoUpgrade behavior. Before dispatching the first workflow task, this field is set to the deployment version on which the parent/ previous run was operating. This inheritance only happens when the task queues belong to the same deployment version. The first workflow task will then be dispatched to either this inherited deployment version, or the current deployment version of the task queue's Deployment. After the first workflow task, the effective behavior depends on worker-sent values in subsequent workflow tasks. Inheritance rules: - ContinueAsNew and child workflows: inherit AutoUpgrade behavior and deployment version - Cron: never inherits - Retry: inherits only if the retried run is effectively AutoUpgrade at the time of retry, and inherited AutoUpgrade behavior when it started (i.e. it is a child of an AutoUpgrade parent or ContinueAsNew of an AutoUpgrade run, running on the same deployment as the parent/previous run) Additional notes: - This field is mutually exclusive with `inherited_pinned_version`. - `versioning_override`, if present, overrides this field during routing decisions. - SDK implementations do not interact with this field and is only used internally by the server to ensure task routing correctness..temporal.api.deployment.v1.InheritedAutoUpgradeInfo inherited_auto_upgrade_info = 39;- Specified by:
hasInheritedAutoUpgradeInfoin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the inheritedAutoUpgradeInfo field is set.
-
getInheritedAutoUpgradeInfo
If present, the new workflow begins with AutoUpgrade behavior. Before dispatching the first workflow task, this field is set to the deployment version on which the parent/ previous run was operating. This inheritance only happens when the task queues belong to the same deployment version. The first workflow task will then be dispatched to either this inherited deployment version, or the current deployment version of the task queue's Deployment. After the first workflow task, the effective behavior depends on worker-sent values in subsequent workflow tasks. Inheritance rules: - ContinueAsNew and child workflows: inherit AutoUpgrade behavior and deployment version - Cron: never inherits - Retry: inherits only if the retried run is effectively AutoUpgrade at the time of retry, and inherited AutoUpgrade behavior when it started (i.e. it is a child of an AutoUpgrade parent or ContinueAsNew of an AutoUpgrade run, running on the same deployment as the parent/previous run) Additional notes: - This field is mutually exclusive with `inherited_pinned_version`. - `versioning_override`, if present, overrides this field during routing decisions. - SDK implementations do not interact with this field and is only used internally by the server to ensure task routing correctness..temporal.api.deployment.v1.InheritedAutoUpgradeInfo inherited_auto_upgrade_info = 39;- Specified by:
getInheritedAutoUpgradeInfoin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The inheritedAutoUpgradeInfo.
-
getInheritedAutoUpgradeInfoOrBuilder
If present, the new workflow begins with AutoUpgrade behavior. Before dispatching the first workflow task, this field is set to the deployment version on which the parent/ previous run was operating. This inheritance only happens when the task queues belong to the same deployment version. The first workflow task will then be dispatched to either this inherited deployment version, or the current deployment version of the task queue's Deployment. After the first workflow task, the effective behavior depends on worker-sent values in subsequent workflow tasks. Inheritance rules: - ContinueAsNew and child workflows: inherit AutoUpgrade behavior and deployment version - Cron: never inherits - Retry: inherits only if the retried run is effectively AutoUpgrade at the time of retry, and inherited AutoUpgrade behavior when it started (i.e. it is a child of an AutoUpgrade parent or ContinueAsNew of an AutoUpgrade run, running on the same deployment as the parent/previous run) Additional notes: - This field is mutually exclusive with `inherited_pinned_version`. - `versioning_override`, if present, overrides this field during routing decisions. - SDK implementations do not interact with this field and is only used internally by the server to ensure task routing correctness..temporal.api.deployment.v1.InheritedAutoUpgradeInfo inherited_auto_upgrade_info = 39;- Specified by:
getInheritedAutoUpgradeInfoOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
getEagerExecutionAccepted
public boolean getEagerExecutionAccepted()A boolean indicating whether the SDK has asked to eagerly execute the first workflow task for this workflow and eager execution was accepted by the server. Only populated by server with version >= 1.29.0.
bool eager_execution_accepted = 38;- Specified by:
getEagerExecutionAcceptedin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The eagerExecutionAccepted.
-
hasDeclinedTargetVersionUpgrade
public boolean hasDeclinedTargetVersionUpgrade()During a previous run of this workflow, the server may have notified the SDK that the Target Worker Deployment Version changed, but the SDK declined to upgrade (e.g., by continuing-as-new with PINNED behavior). This field records the target version that was declined. This is a wrapper message to distinguish "never declined" (nil wrapper) from "declined an unversioned target" (non-nil wrapper with nil deployment_version). Used internally by the server during continue-as-new and retry. Should not be read or interpreted by SDKs.
.temporal.api.history.v1.DeclinedTargetVersionUpgrade declined_target_version_upgrade = 40;- Specified by:
hasDeclinedTargetVersionUpgradein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the declinedTargetVersionUpgrade field is set.
-
getDeclinedTargetVersionUpgrade
During a previous run of this workflow, the server may have notified the SDK that the Target Worker Deployment Version changed, but the SDK declined to upgrade (e.g., by continuing-as-new with PINNED behavior). This field records the target version that was declined. This is a wrapper message to distinguish "never declined" (nil wrapper) from "declined an unversioned target" (non-nil wrapper with nil deployment_version). Used internally by the server during continue-as-new and retry. Should not be read or interpreted by SDKs.
.temporal.api.history.v1.DeclinedTargetVersionUpgrade declined_target_version_upgrade = 40;- Specified by:
getDeclinedTargetVersionUpgradein interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The declinedTargetVersionUpgrade.
-
getDeclinedTargetVersionUpgradeOrBuilder
During a previous run of this workflow, the server may have notified the SDK that the Target Worker Deployment Version changed, but the SDK declined to upgrade (e.g., by continuing-as-new with PINNED behavior). This field records the target version that was declined. This is a wrapper message to distinguish "never declined" (nil wrapper) from "declined an unversioned target" (non-nil wrapper with nil deployment_version). Used internally by the server during continue-as-new and retry. Should not be read or interpreted by SDKs.
.temporal.api.history.v1.DeclinedTargetVersionUpgrade declined_target_version_upgrade = 40;- Specified by:
getDeclinedTargetVersionUpgradeOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasTimeSkippingConfig
public boolean hasTimeSkippingConfig()Initial time-skipping configuration for this workflow execution, recorded at start time. This may have been set explicitly via the start workflow request, or propagated from a parent/previous execution. The configuration may be updated after start via UpdateWorkflowExecutionOptions, which will be reflected in the WorkflowExecutionOptionsUpdatedEvent.
.temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 41;- Specified by:
hasTimeSkippingConfigin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the timeSkippingConfig field is set.
-
getTimeSkippingConfig
Initial time-skipping configuration for this workflow execution, recorded at start time. This may have been set explicitly via the start workflow request, or propagated from a parent/previous execution. The configuration may be updated after start via UpdateWorkflowExecutionOptions, which will be reflected in the WorkflowExecutionOptionsUpdatedEvent.
.temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 41;- Specified by:
getTimeSkippingConfigin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The timeSkippingConfig.
-
getTimeSkippingConfigOrBuilder
Initial time-skipping configuration for this workflow execution, recorded at start time. This may have been set explicitly via the start workflow request, or propagated from a parent/previous execution. The configuration may be updated after start via UpdateWorkflowExecutionOptions, which will be reflected in the WorkflowExecutionOptionsUpdatedEvent.
.temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 41;- Specified by:
getTimeSkippingConfigOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
hasTimeSkippingStatePropagation
public boolean hasTimeSkippingStatePropagation()The time-skipping state propagated from a previous run of this workflow. This can be nil if no time skipping has occurred or there is no previous run.
.temporal.api.common.v1.TimeSkippingStatePropagation time_skipping_state_propagation = 43;- Specified by:
hasTimeSkippingStatePropagationin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- Whether the timeSkippingStatePropagation field is set.
-
getTimeSkippingStatePropagation
The time-skipping state propagated from a previous run of this workflow. This can be nil if no time skipping has occurred or there is no previous run.
.temporal.api.common.v1.TimeSkippingStatePropagation time_skipping_state_propagation = 43;- Specified by:
getTimeSkippingStatePropagationin interfaceWorkflowExecutionStartedEventAttributesOrBuilder- Returns:
- The timeSkippingStatePropagation.
-
getTimeSkippingStatePropagationOrBuilder
The time-skipping state propagated from a previous run of this workflow. This can be nil if no time skipping has occurred or there is no previous run.
.temporal.api.common.v1.TimeSkippingStatePropagation time_skipping_state_propagation = 43;- Specified by:
getTimeSkippingStatePropagationOrBuilderin interfaceWorkflowExecutionStartedEventAttributesOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static WorkflowExecutionStartedEventAttributes parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static WorkflowExecutionStartedEventAttributes parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static WorkflowExecutionStartedEventAttributes parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static WorkflowExecutionStartedEventAttributes.Builder newBuilder(WorkflowExecutionStartedEventAttributes prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected WorkflowExecutionStartedEventAttributes.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-