package temporal.api.history.v1
Get desktop application:
View/edit binary Protocol Buffers messages
message
message.proto:944Used in:
int64 scheduled_event_id = 1
The id of the `ACTIVITY_TASK_SCHEDULED` event this modification corresponds to.
optional new_retry_policy = 2
If set, update the retry policy of the activity, replacing it with the specified one. The number of attempts at the activity is preserved.
message
message.proto:533Used in:
int64 scheduled_event_id = 1
The id of the `ACTIVITY_TASK_SCHEDULED` event this cancel request corresponds to
int64 workflow_task_completed_event_id = 2
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
message
message.proto:540Used in:
optional details = 1
Additional information that the activity reported upon confirming cancellation
int64 latest_cancel_requested_event_id = 2
id of the most recent `ACTIVITY_TASK_CANCEL_REQUESTED` event which refers to the same activity
int64 scheduled_event_id = 3
The id of the `ACTIVITY_TASK_SCHEDULED` event this cancel confirmation corresponds to
int64 started_event_id = 4
The id of the `ACTIVITY_TASK_STARTED` event this cancel confirmation corresponds to
string identity = 5
id of the worker who canceled this activity
optional worker_version = 6
Version info of the worker who processed this workflow task. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
message
message.proto:493Used in:
optional result = 1
Serialized results of the activity. IE: The return value of the activity function
int64 scheduled_event_id = 2
The id of the `ACTIVITY_TASK_SCHEDULED` event this completion corresponds to
int64 started_event_id = 3
The id of the `ACTIVITY_TASK_STARTED` event this completion corresponds to
string identity = 4
id of the worker that completed this task
optional worker_version = 5
Version info of the worker who processed this workflow task. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
message
message.proto:507Used in:
optional failure = 1
Failure details
int64 scheduled_event_id = 2
The id of the `ACTIVITY_TASK_SCHEDULED` event this failure corresponds to
int64 started_event_id = 3
The id of the `ACTIVITY_TASK_STARTED` event this failure corresponds to
string identity = 4
id of the worker that failed this task
enums.v1.RetryState retry_state = 5
optional worker_version = 6
Version info of the worker who processed this workflow task. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
message
message.proto:420Used in:
string activity_id = 1
The worker/user assigned identifier for the activity
optional activity_type = 2
optional task_queue = 4
optional header = 5
optional input = 6
optional schedule_to_close_timeout = 7
Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional schedule_to_start_timeout = 8
Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional start_to_close_timeout = 9
Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or `schedule_to_close_timeout` must be specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional heartbeat_timeout = 10
Maximum permitted time between successful worker heartbeats.
int64 workflow_task_completed_event_id = 11
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
optional retry_policy = 12
Activities are assigned a default retry policy controlled by the service's dynamic configuration. Retries will happen up to `schedule_to_close_timeout`. To disable retries set retry_policy.maximum_attempts to 1.
bool use_workflow_build_id = 13
If this is set, the activity would be assigned to the Build ID of the workflow. Otherwise, Assignment rules of the activity's Task Queue will be used to determine the Build ID. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
optional priority = 14
Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.
message
message.proto:467Used in:
int64 scheduled_event_id = 1
The id of the `ACTIVITY_TASK_SCHEDULED` event this task corresponds to
string identity = 2
id of the worker that picked up this task
string request_id = 3
This field is populated from the RecordActivityTaskStartedRequest. Matching service would set the request_id on the RecordActivityTaskStartedRequest to a new UUID. This is useful in case a RecordActivityTaskStarted call succeed but matching doesn't get that response, so matching could retry and history service would return success if the request_id matches. In that case, matching will continue to deliver the task to worker. Without this field, history service would return AlreadyStarted error, and matching would drop the task.
int32 attempt = 4
Starting at 1, the number of times this task has been attempted
optional last_failure = 5
Will be set to the most recent failure details, if this task has previously failed and then been retried.
optional worker_version = 6
Version info of the worker to whom this task was dispatched. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
int64 build_id_redirect_counter = 7
Used by server internally to properly reapply build ID redirects to an execution when rebuilding it from events. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
message
message.proto:522Used in:
optional failure = 1
If this activity had failed, was retried, and then timed out, that failure is stored as the `cause` in here.
int64 scheduled_event_id = 2
The id of the `ACTIVITY_TASK_SCHEDULED` event this timeout corresponds to
int64 started_event_id = 3
The id of the `ACTIVITY_TASK_STARTED` event this timeout corresponds to
enums.v1.RetryState retry_state = 4
message
message.proto:852Used in:
optional details = 1
string namespace = 2
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 7
optional workflow_execution = 3
optional workflow_type = 4
int64 initiated_event_id = 5
Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
int64 started_event_id = 6
Id of the `CHILD_WORKFLOW_EXECUTION_STARTED` event which this event corresponds to
message
message.proto:823Used in:
optional result = 1
string namespace = 2
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 7
optional workflow_execution = 3
optional workflow_type = 4
int64 initiated_event_id = 5
Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
int64 started_event_id = 6
Id of the `CHILD_WORKFLOW_EXECUTION_STARTED` event which this event corresponds to
message
message.proto:837Used in:
optional failure = 1
string namespace = 2
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 8
optional workflow_execution = 3
optional workflow_type = 4
int64 initiated_event_id = 5
Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
int64 started_event_id = 6
Id of the `CHILD_WORKFLOW_EXECUTION_STARTED` event which this event corresponds to
enums.v1.RetryState retry_state = 7
message
message.proto:811Used in:
string namespace = 1
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 6
int64 initiated_event_id = 2
Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
optional workflow_execution = 3
optional workflow_type = 4
optional header = 5
message
message.proto:880Used in:
string namespace = 1
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 6
optional workflow_execution = 2
optional workflow_type = 3
int64 initiated_event_id = 4
Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
int64 started_event_id = 5
Id of the `CHILD_WORKFLOW_EXECUTION_STARTED` event which this event corresponds to
message
message.proto:866Used in:
string namespace = 1
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 7
optional workflow_execution = 2
optional workflow_type = 3
int64 initiated_event_id = 4
Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
int64 started_event_id = 5
Id of the `CHILD_WORKFLOW_EXECUTION_STARTED` event which this event corresponds to
enums.v1.RetryState retry_state = 6
message
message.proto:221Wrapper for a target deployment version that the SDK declined to upgrade to. See declined_target_version_upgrade on WorkflowExecutionStartedEventAttributes.
Used in:
optional deployment_version = 1
int64 revision_number = 2
Revision number of the task queue routing config at the time the target was declined. If an incoming target's revision is <= this value, it is not newer and is not used for deciding whether or not to suppress the upgrade signal.
message
message.proto:676Used in:
int64 initiated_event_id = 1
id of the `REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED` event this event corresponds to
string namespace = 2
Namespace of the to-be-cancelled workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 4
optional workflow_execution = 3
message
message.proto:721Used in:
int64 initiated_event_id = 1
id of the `SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED` event this event corresponds to
string namespace = 2
Namespace of the workflow which was signaled. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 5
optional workflow_execution = 3
string control = 4
Deprecated.
message
message.proto:1278Used in: , , ,
repeated events = 1
message
message.proto:1182History events are the method by which Temporal SDKs advance (or recreate) workflow state. See the `EventType` enum for more info about what each event is for.
Used in:
int64 event_id = 1
Monotonically increasing event number, starts at 1.
optional event_time = 2
enums.v1.EventType event_type = 3
int64 version = 4
Failover version of the event, used by the server for multi-cluster replication and history versioning. SDKs generally ignore this field.
int64 task_id = 5
Identifier used by the service to order replication and transfer tasks associated with this event. SDKs generally ignore this field.
bool worker_may_ignore = 300
Set to true when the SDK may ignore the event as it does not impact workflow state or information in any way that the SDK need be concerned with. If an SDK encounters an event type which it does not understand, it must error unless this is true. If it is true, it's acceptable for the event type and/or attributes to be uninterpretable.
optional user_metadata = 301
Metadata on the event. This is often carried over from commands and client calls. Most events won't have this information, and how this information is used is dependent upon the interface that reads it. Current well-known uses: * workflow_execution_started_event_attributes - summary and details from start workflow. * timer_started_event_attributes - summary represents an identifier for the timer for use by user interfaces.
repeated links = 302
Links to related entities, such as the entity that started this event's workflow.
optional principal = 303
Server-computed authenticated caller identity associated with this event.
repeated event_group_markers = 304
Event group markers attached to this event.
oneof attributes
The event details. The type must match that in `event_type`.
workflow_execution_started_event_attributes = 6
workflow_execution_completed_event_attributes = 7
workflow_execution_failed_event_attributes = 8
workflow_execution_timed_out_event_attributes = 9
workflow_task_scheduled_event_attributes = 10
workflow_task_started_event_attributes = 11
workflow_task_completed_event_attributes = 12
workflow_task_timed_out_event_attributes = 13
workflow_task_failed_event_attributes = 14
activity_task_scheduled_event_attributes = 15
activity_task_started_event_attributes = 16
activity_task_completed_event_attributes = 17
activity_task_failed_event_attributes = 18
activity_task_timed_out_event_attributes = 19
timer_started_event_attributes = 20
timer_fired_event_attributes = 21
activity_task_cancel_requested_event_attributes = 22
activity_task_canceled_event_attributes = 23
timer_canceled_event_attributes = 24
marker_recorded_event_attributes = 25
workflow_execution_signaled_event_attributes = 26
workflow_execution_terminated_event_attributes = 27
workflow_execution_cancel_requested_event_attributes = 28
workflow_execution_canceled_event_attributes = 29
request_cancel_external_workflow_execution_initiated_event_attributes = 30
request_cancel_external_workflow_execution_failed_event_attributes = 31
external_workflow_execution_cancel_requested_event_attributes = 32
workflow_execution_continued_as_new_event_attributes = 33
start_child_workflow_execution_initiated_event_attributes = 34
start_child_workflow_execution_failed_event_attributes = 35
child_workflow_execution_started_event_attributes = 36
child_workflow_execution_completed_event_attributes = 37
child_workflow_execution_failed_event_attributes = 38
child_workflow_execution_canceled_event_attributes = 39
child_workflow_execution_timed_out_event_attributes = 40
child_workflow_execution_terminated_event_attributes = 41
signal_external_workflow_execution_initiated_event_attributes = 42
signal_external_workflow_execution_failed_event_attributes = 43
external_workflow_execution_signaled_event_attributes = 44
upsert_workflow_search_attributes_event_attributes = 45
workflow_execution_update_accepted_event_attributes = 46
workflow_execution_update_rejected_event_attributes = 47
workflow_execution_update_completed_event_attributes = 48
workflow_properties_modified_externally_event_attributes = 49
activity_properties_modified_externally_event_attributes = 50
workflow_properties_modified_event_attributes = 51
workflow_execution_update_admitted_event_attributes = 52
nexus_operation_scheduled_event_attributes = 53
nexus_operation_started_event_attributes = 54
nexus_operation_completed_event_attributes = 55
nexus_operation_failed_event_attributes = 56
nexus_operation_canceled_event_attributes = 57
nexus_operation_timed_out_event_attributes = 58
nexus_operation_cancel_requested_event_attributes = 59
workflow_execution_options_updated_event_attributes = 60
nexus_operation_cancel_request_completed_event_attributes = 61
nexus_operation_cancel_request_failed_event_attributes = 62
workflow_execution_paused_event_attributes = 63
workflow_execution_unpaused_event_attributes = 64
workflow_execution_time_skipping_transitioned_event_attributes = 65
message
message.proto:604Used in:
string marker_name = 1
Workers use this to identify the "types" of various markers. Ex: Local activity, side effect.
map<string, > details = 2
Serialized information recorded in the marker
int64 workflow_task_completed_event_id = 3
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
optional header = 4
optional failure = 5
Some uses of markers, like a local activity, could "fail". If they did that is recorded here.
message
message.proto:1158Used in:
int64 requested_event_id = 1
The ID of the `NEXUS_OPERATION_CANCEL_REQUESTED` event.
int64 workflow_task_completed_event_id = 2
The `WORKFLOW_TASK_COMPLETED` event that the corresponding RequestCancelNexusOperation command was reported with.
int64 scheduled_event_id = 3
The id of the `NEXUS_OPERATION_SCHEDULED` event this cancel request corresponds to.
message
message.proto:1168Used in:
int64 requested_event_id = 1
The ID of the `NEXUS_OPERATION_CANCEL_REQUESTED` event.
int64 workflow_task_completed_event_id = 2
The `WORKFLOW_TASK_COMPLETED` event that the corresponding RequestCancelNexusOperation command was reported with.
optional failure = 3
Failure details. A NexusOperationFailureInfo wrapping a CanceledFailureInfo.
int64 scheduled_event_id = 4
The id of the `NEXUS_OPERATION_SCHEDULED` event this cancel request corresponds to.
message
message.proto:1150Used in:
int64 scheduled_event_id = 1
The id of the `NEXUS_OPERATION_SCHEDULED` event this cancel request corresponds to.
int64 workflow_task_completed_event_id = 2
The `WORKFLOW_TASK_COMPLETED` event that the corresponding RequestCancelNexusOperation command was reported with.
message
message.proto:1140Nexus operation completed as canceled. May or may not have been due to a cancellation request by the workflow.
Used in:
int64 scheduled_event_id = 1
The ID of the `NEXUS_OPERATION_SCHEDULED` event. Uniquely identifies this operation.
optional failure = 2
Cancellation details.
string request_id = 3
The request ID allocated at schedule time.
message
message.proto:1106Nexus operation completed successfully.
Used in:
int64 scheduled_event_id = 1
The ID of the `NEXUS_OPERATION_SCHEDULED` event. Uniquely identifies this operation.
optional result = 2
Serialized result of the Nexus operation. The response of the Nexus handler. Delivered either via a completion callback or as a response to a synchronous operation.
string request_id = 3
The request ID allocated at schedule time.
message
message.proto:1118Nexus operation failed.
Used in:
int64 scheduled_event_id = 1
The ID of the `NEXUS_OPERATION_SCHEDULED` event. Uniquely identifies this operation.
optional failure = 2
Failure details. A NexusOperationFailureInfo wrapping an ApplicationFailureInfo.
string request_id = 3
The request ID allocated at schedule time.
message
message.proto:1037Event marking that an operation was scheduled by a workflow via the ScheduleNexusOperation command.
Used in:
string endpoint = 1
Endpoint name, must exist in the endpoint registry.
string service = 2
Service name.
string operation = 3
Operation name.
optional input = 4
Input for the operation. The server converts this into Nexus request content and the appropriate content headers internally when sending the StartOperation request. On the handler side, if it is also backed by Temporal, the content is transformed back to the original Payload stored in this event.
optional schedule_to_close_timeout = 5
Schedule-to-close timeout for this operation. Indicates how long the caller is willing to wait for operation completion. Calls are retried internally by the server. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --) (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: "timeout" is an acceptable suffix for duration fields in this API. --)
map<string, string> nexus_header = 6
Header to attach to the Nexus request. Note these headers are not the same as Temporal headers on internal activities and child workflows, these are transmitted to Nexus operations that may be external and are not traditional payloads.
int64 workflow_task_completed_event_id = 7
The `WORKFLOW_TASK_COMPLETED` event that the corresponding ScheduleNexusOperation command was reported with.
string request_id = 8
A unique ID generated by the history service upon creation of this event. The ID will be transmitted with all nexus StartOperation requests and is used as an idempotentency key.
string endpoint_id = 9
Endpoint ID as resolved in the endpoint registry at the time this event was generated. This is stored on the event and used internally by the server in case the endpoint is renamed from the time the event was originally scheduled.
optional schedule_to_start_timeout = 10
Schedule-to-start timeout for this operation. See ScheduleNexusOperationCommandAttributes.schedule_to_start_timeout for details. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional start_to_close_timeout = 11
Start-to-close timeout for this operation. See ScheduleNexusOperationCommandAttributes.start_to_close_timeout for details. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
message
message.proto:1088Event marking an asynchronous operation was started by the responding Nexus handler. If the operation completes synchronously, this event is not generated. In rare situations, such as request timeouts, the service may fail to record the actual start time and will fabricate this event upon receiving the operation completion via callback.
Used in:
int64 scheduled_event_id = 1
The ID of the `NEXUS_OPERATION_SCHEDULED` event this task corresponds to.
string operation_id = 3
The operation ID returned by the Nexus handler in the response to the StartOperation request. This ID is used when canceling the operation. Deprecated: Renamed to operation_token.
string request_id = 4
The request ID allocated at schedule time.
string operation_token = 5
The operation token returned by the Nexus handler in the response to the StartOperation request. This token is used when canceling the operation.
message
message.proto:1129Nexus operation timed out.
Used in:
int64 scheduled_event_id = 1
The ID of the `NEXUS_OPERATION_SCHEDULED` event. Uniquely identifies this operation.
optional failure = 2
Failure details. A NexusOperationFailureInfo wrapping a CanceledFailureInfo.
string request_id = 3
The request ID allocated at schedule time.
message
message.proto:660Used in:
enums.v1.CancelExternalWorkflowExecutionFailedCause cause = 1
int64 workflow_task_completed_event_id = 2
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
string namespace = 3
Namespace of the workflow which failed to cancel. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 7
optional workflow_execution = 4
int64 initiated_event_id = 5
id of the `REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED` event this failure corresponds to
string control = 6
Deprecated.
message
message.proto:643Used in:
int64 workflow_task_completed_event_id = 1
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
string namespace = 2
The namespace the workflow to be cancelled lives in. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 7
optional workflow_execution = 3
string control = 4
Deprecated.
bool child_workflow_only = 5
Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request
string reason = 6
Reason for requesting the cancellation
message
message.proto:707Used in:
enums.v1.SignalExternalWorkflowExecutionFailedCause cause = 1
int64 workflow_task_completed_event_id = 2
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
string namespace = 3
Namespace of the workflow which failed the signal. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 7
optional workflow_execution = 4
int64 initiated_event_id = 5
string control = 6
Deprecated.
message
message.proto:687Used in:
int64 workflow_task_completed_event_id = 1
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
string namespace = 2
Namespace of the to-be-signalled workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 9
optional workflow_execution = 3
string signal_name = 4
name/type of the signal to fire in the external workflow
optional input = 5
Serialized arguments to provide to the signal handler
string control = 6
Deprecated.
bool child_workflow_only = 7
Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request
optional header = 8
message
message.proto:795Used in:
string namespace = 1
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 8
string workflow_id = 2
optional workflow_type = 3
enums.v1.StartChildWorkflowExecutionFailedCause cause = 4
string control = 5
Deprecated.
int64 initiated_event_id = 6
Id of the `START_CHILD_WORKFLOW_EXECUTION_INITIATED` event which this event corresponds to
int64 workflow_task_completed_event_id = 7
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
message
message.proto:748Used in:
string namespace = 1
Namespace of the child workflow. SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
string namespace_id = 18
string workflow_id = 2
optional workflow_type = 3
optional task_queue = 4
optional input = 5
optional workflow_execution_timeout = 6
Total workflow execution timeout including retries and continue as new.
optional workflow_run_timeout = 7
Timeout of a single workflow run.
optional workflow_task_timeout = 8
Timeout of a single workflow task.
enums.v1.ParentClosePolicy parent_close_policy = 9
Default: PARENT_CLOSE_POLICY_TERMINATE.
string control = 10
Deprecated.
int64 workflow_task_completed_event_id = 11
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 12
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
optional retry_policy = 13
string cron_schedule = 14
If this child runs on a cron schedule, it will appear here
optional header = 15
optional memo = 16
optional search_attributes = 17
bool inherit_build_id = 19
If this is set, the child workflow inherits the Build ID of the parent. Otherwise, the assignment rules of the child's Task Queue will be used to independently assign a Build ID to it. Deprecated. Only considered for versioning v0.2.
optional priority = 20
Priority metadata
optional time_skipping_config = 21
The propagated time-skipping configuration for the child workflow.
optional time_skipping_state_propagation = 23
The time-skipping state propagated from the parent workflow. This can be nil if no time skipping has occurred or there is no previous run.
message
message.proto:576Used in:
string timer_id = 1
Will match the `timer_id` from `TIMER_STARTED` event for this timer
int64 started_event_id = 2
The id of the `TIMER_STARTED` event itself
int64 workflow_task_completed_event_id = 3
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
string identity = 4
The id of the worker who requested this cancel
message
message.proto:569Used in:
string timer_id = 1
Will match the `timer_id` from `TIMER_STARTED` event for this timer
int64 started_event_id = 2
The id of the `TIMER_STARTED` event itself
message
message.proto:557Used in:
string timer_id = 1
The worker/user assigned id for this timer
optional start_to_fire_timeout = 2
How long until this timer fires (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
int64 workflow_task_completed_event_id = 3
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
message
message.proto:733Used in:
int64 workflow_task_completed_event_id = 1
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
optional search_attributes = 2
message
message.proto:587Used in:
string cause = 1
User provided reason for requesting cancellation
int64 external_initiated_event_id = 2
The ID of the `REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED` event in the external workflow history when the cancellation was requested by another workflow.
optional external_workflow_execution = 3
string identity = 4
id of the worker or client who requested this cancel
message
message.proto:598Used in:
int64 workflow_task_completed_event_id = 1
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
optional details = 2
message
message.proto:230Used in:
optional result = 1
Serialized result of workflow completion (ie: The return value of the workflow function)
int64 workflow_task_completed_event_id = 2
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
string new_execution_run_id = 3
If another run is started by cron, this contains the new run id.
message
message.proto:255Used in:
string new_execution_run_id = 1
The run ID of the new workflow started by this continue-as-new
optional workflow_type = 2
optional task_queue = 3
optional input = 4
optional workflow_run_timeout = 5
Timeout of a single workflow run.
optional workflow_task_timeout = 6
Timeout of a single workflow task.
int64 workflow_task_completed_event_id = 7
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
optional backoff_start_interval = 8
How long the server will wait before scheduling the first workflow task for the new run. Used for cron, retry, and other continue-as-new cases that server may enforce some minimal delay between new runs for system protection purpose.
enums.v1.ContinueAsNewInitiator initiator = 9
optional failure = 10
Deprecated. If a workflow's retry policy would cause a new run to start when the current one has failed, this field would be populated with that failure. Now (when supported by server and sdk) the final event will be `WORKFLOW_EXECUTION_FAILED` with `new_execution_run_id` set.
optional last_completion_result = 11
The result from the most recent completed run of this workflow. The SDK surfaces this to the new run via APIs such as `GetLastCompletionResult`.
optional header = 12
optional memo = 13
optional search_attributes = 14
bool inherit_build_id = 15
If this is set, the new execution inherits the Build ID of the current execution. Otherwise, the assignment rules will be used to independently assign a Build ID to the new execution. Deprecated. Only considered for versioning v0.2.
enums.v1.ContinueAsNewVersioningBehavior initial_versioning_behavior = 16
Experimental. Optionally decide the versioning behavior that the first task of the new run should use. For example, choose to AutoUpgrade on continue-as-new instead of inheriting the pinned version of the previous run.
message
message.proto:239Used in:
optional failure = 1
Serialized result of workflow failure (ex: An exception thrown, or error returned)
enums.v1.RetryState retry_state = 2
int64 workflow_task_completed_event_id = 3
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
string new_execution_run_id = 4
If another run is started by cron or retry, this contains the new run id.
message
message.proto:893Used in:
optional versioning_override = 1
Versioning override upserted in this event. Ignored if nil or if unset_versioning_override is true.
bool unset_versioning_override = 2
Versioning override removed in this event.
string attached_request_id = 3
Request ID attached to the running workflow execution so that subsequent requests with same request ID will be deduped.
repeated attached_completion_callbacks = 4
Completion callbacks attached to the running workflow execution.
string identity = 5
Optional. The identity of the client who initiated the request that created this event.
optional priority = 6
Priority override upserted in this event. Represents the full priority; not just partial fields. Ignored if nil.
optional time_skipping_config = 7
TimeSkippingConfig override upserted in this event. Represents the full config.
bool time_skipping_config_updated = 9
Indicates the time skipping config was updated by the recent call to update workflow execution options.
repeated workflow_update_options = 8
Updates to workflow updates options.
message
message.proto:894Used in:
string update_id = 1
The ID of the workflow update this update options update corresponds to.
string attached_request_id = 2
Request ID attached to the running workflow update so that subsequent requests with same request ID will be deduped
repeated attached_completion_callbacks = 3
Completion callbacks attached to the running workflow update.
message
message.proto:1001Attributes for an event marking that a workflow execution was paused.
Used in:
string identity = 1
The identity of the client who paused the workflow execution.
string reason = 2
The reason for pausing the workflow execution.
string request_id = 3
The request ID of the request that paused the workflow execution.
message
message.proto:616Used in:
string signal_name = 1
The name/type of the signal to fire
optional input = 2
Will be deserialized and provided as argument(s) to the signal handler
string identity = 3
id of the worker/client who sent this signal
optional header = 4
Headers that were passed by the sender of the signal and copied by temporal server into the workflow task.
bool skip_generate_workflow_task = 5
Deprecated. This field is never respected and should always be set to false.
optional external_workflow_execution = 6
When signal origin is a workflow execution, this field is set.
string request_id = 7
The request ID of the Signal request, used by the server to attach this to the correct Event ID when generating link.
message
message.proto:30Always the first event in workflow history
Used in:
optional workflow_type = 1
string parent_workflow_namespace = 2
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_id = 27
optional parent_workflow_execution = 3
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.
int64 parent_initiated_event_id = 4
EventID of the child execution initiated event in parent workflow
optional task_queue = 5
optional input = 6
SDK will deserialize this and provide it as arguments to the workflow function
optional workflow_execution_timeout = 7
Total workflow execution timeout including retries and continue as new.
optional workflow_run_timeout = 8
Timeout of a single workflow run.
optional workflow_task_timeout = 9
Timeout of a single workflow task.
string continued_execution_run_id = 10
Run id of the previous workflow which continued-as-new or retried or cron executed into this workflow.
enums.v1.ContinueAsNewInitiator initiator = 11
optional continued_failure = 12
optional last_completion_result = 13
string original_execution_run_id = 14
This is the run id when the WorkflowExecutionStarted event was written. A workflow reset changes the execution run_id, but preserves this field.
string identity = 15
Identity of the client who requested this execution
string first_execution_run_id = 16
This is the very first runId along the chain of ContinueAsNew, Retry, Cron and Reset. Used to identify a chain.
optional retry_policy = 17
int32 attempt = 18
Starting at 1, the number of times we have tried to execute this workflow
optional workflow_execution_expiration_time = 19
The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.
string cron_schedule = 20
If this workflow runs on a cron schedule, it will appear here
optional first_workflow_task_backoff = 21
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.
optional memo = 22
optional search_attributes = 23
optional prev_auto_reset_points = 24
optional header = 25
int64 parent_initiated_event_version = 26
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
string workflow_id = 28
This field is new in 1.21.
optional source_version_stamp = 29
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]
repeated completion_callbacks = 30
Completion callbacks attached when this workflow was started.
optional root_workflow_execution = 31
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.
string inherited_build_id = 32
When 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]
optional versioning_override = 33
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.
string parent_pinned_worker_deployment_version = 34
When 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`.
optional priority = 35
Priority metadata
optional inherited_pinned_version = 37
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.
optional inherited_auto_upgrade_info = 39
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.
bool eager_execution_accepted = 38
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.
optional declined_target_version_upgrade = 40
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.
optional time_skipping_config = 41
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.
optional time_skipping_state_propagation = 43
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.
message
message.proto:635Used in:
string reason = 1
User/client provided reason for termination
optional details = 2
string identity = 3
id of the client who requested termination
message
message.proto:1023Attributes for an event indicating that time skipping state changed for a workflow execution, either time was advanced or time skipping was disabled automatically due to the fast_forward completing. The worker_may_ignore field in HistoryEvent should always be set true for this event.
Used in:
optional target_time = 1
The virtual time point that time skipping advanced to.
bool disabled_after_fast_forward = 2
When true, time skipping has been disabled automatically due to a call to fast_forward completing. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "after" is used to indicate temporal ordering. --)
optional wall_clock_time = 3
The wall-clock time when the time-skipping state changed event was generated.
message
message.proto:249Used in:
enums.v1.RetryState retry_state = 1
string new_execution_run_id = 2
If another run is started by cron or retry, this contains the new run id.
message
message.proto:1011Attributes for an event marking that a workflow execution was unpaused.
Used in:
string identity = 1
The identity of the client who unpaused the workflow execution.
string reason = 2
The reason for unpausing the workflow execution.
string request_id = 3
The request ID of the request that unpaused the workflow execution.
message
message.proto:952Used in:
string protocol_instance_id = 1
The instance ID of the update protocol that generated this event.
string accepted_request_message_id = 2
The message ID of the original request message that initiated this update. Needed so that the worker can recreate and deliver that same message as part of replay.
int64 accepted_request_sequencing_event_id = 3
The event ID used to sequence the original request message.
optional accepted_request = 4
The message payload of the original request message that initiated this update.
message
message.proto:993Used in:
optional request = 1
The update request associated with this event.
enums.v1.UpdateAdmittedEventOrigin origin = 2
An explanation of why this event was written to history.
message
message.proto:966Used in:
optional meta = 1
The metadata about this update.
int64 accepted_event_id = 3
The event ID indicating the acceptance of this update.
optional outcome = 2
The outcome of executing the workflow update function.
message
message.proto:977Used in:
string protocol_instance_id = 1
The instance ID of the update protocol that generated this event.
string rejected_request_message_id = 2
The message ID of the original request message that initiated this update. Needed so that the worker can recreate and deliver that same message as part of replay.
int64 rejected_request_sequencing_event_id = 3
The event ID used to sequence the original request message.
optional rejected_request = 4
The message payload of the original request message that initiated this update.
optional failure = 5
The cause of rejection.
message
message.proto:739Used in:
int64 workflow_task_completed_event_id = 1
The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
optional upserted_memo = 2
If set, update the workflow memo with the provided values. The values will be merged with the existing memo. If the user wants to delete values, a default/empty Payload should be used as the value for the key being deleted.
message
message.proto:931Not used anywhere. Use case is replaced by WorkflowExecutionOptionsUpdatedEventAttributes
Used in:
string new_task_queue = 1
Not used.
optional new_workflow_task_timeout = 2
Not used.
optional new_workflow_run_timeout = 3
Not used.
optional new_workflow_execution_timeout = 4
Not used.
optional upserted_memo = 5
Not used.
message
message.proto:341Used in:
int64 scheduled_event_id = 1
The id of the `WORKFLOW_TASK_SCHEDULED` event this task corresponds to
int64 started_event_id = 2
The id of the `WORKFLOW_TASK_STARTED` event this task corresponds to
string identity = 3
Identity of the worker who completed this task
string binary_checksum = 4
Binary ID of the worker who completed this task Deprecated. Replaced with `deployment_version`.
optional worker_version = 5
Version info of the worker who processed this workflow task. If present, the `build_id` field within is also used as `binary_checksum`, which may be omitted in that case (it may also be populated to preserve compatibility). Deprecated. Use `deployment_version` and `versioning_behavior` instead.
optional sdk_metadata = 6
Data the SDK wishes to record for itself, but server need not interpret, and does not directly impact workflow state.
optional metering_metadata = 13
Local usage data sent during workflow task completion and recorded here for posterity
optional deployment = 7
The deployment that completed this task. May or may not be set for unversioned workers, depending on whether a value is sent by the SDK. This value updates workflow execution's `versioning_info.deployment`. Deprecated. Replaced with `deployment_version`.
enums.v1.VersioningBehavior versioning_behavior = 8
Versioning behavior sent by the worker that completed this task for this particular workflow execution. UNSPECIFIED means the task was completed by an unversioned worker. This value updates workflow execution's `versioning_info.behavior`.
string worker_deployment_version = 9
The Worker Deployment Version that completed this task. Must be set if `versioning_behavior` is set. This value updates workflow execution's `versioning_info.version`. Deprecated. Replaced with `deployment_version`.
string worker_deployment_name = 10
The name of Worker Deployment that completed this task. Must be set if `versioning_behavior` is set. This value updates workflow execution's `worker_deployment_name`.
optional deployment_version = 11
The Worker Deployment Version that completed this task. Must be set if `versioning_behavior` is set. This value updates workflow execution's `versioning_info.deployment_version`.
message
message.proto:392Used in:
int64 scheduled_event_id = 1
The id of the `WORKFLOW_TASK_SCHEDULED` event this task corresponds to
int64 started_event_id = 2
The id of the `WORKFLOW_TASK_STARTED` event this task corresponds to
enums.v1.WorkflowTaskFailedCause cause = 3
optional failure = 4
The failure details
string identity = 5
If a worker explicitly failed this task, this field contains the worker's identity. When the server generates the failure internally this field is set as 'history-service'.
string base_run_id = 6
The original run id of the workflow. For reset workflow.
string new_run_id = 7
If the workflow is being reset, the new run id.
int64 fork_event_version = 8
Version of the event where the history branch was forked. Used by multi-cluster replication during resets to identify the correct history branch.
string binary_checksum = 9
Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv] If a worker explicitly failed this task, its binary id
optional worker_version = 10
Version info of the worker who processed this workflow task. If present, the `build_id` field within is also used as `binary_checksum`, which may be omitted in that case (it may also be populated to preserve compatibility). Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
message
message.proto:295Used in:
optional task_queue = 1
The task queue this workflow task was enqueued in, which could be a normal or sticky queue
optional start_to_close_timeout = 2
How long the worker has to process this task once receiving it before it times out (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
int32 attempt = 3
Starting at 1, how many attempts there have been to complete this task
message
message.proto:307Used in:
int64 scheduled_event_id = 1
The id of the `WORKFLOW_TASK_SCHEDULED` event this task corresponds to
string identity = 2
Identity of the worker who picked up this task
string request_id = 3
This field is populated from the RecordWorkflowTaskStartedRequest. Matching service would set the request_id on the RecordWorkflowTaskStartedRequest to a new UUID. This is useful in case a RecordWorkflowTaskStarted call succeed but matching doesn't get that response, so matching could retry and history service would return success if the request_id matches. In that case, matching will continue to deliver the task to worker. Without this field, history service would return AlreadyStarted error, and matching would drop the task.
bool suggest_continue_as_new = 4
True if this workflow should continue-as-new soon. See `suggest_continue_as_new_reasons` for why.
repeated enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8
The reason(s) that suggest_continue_as_new is true, if it is. Unset if suggest_continue_as_new is false.
bool target_worker_deployment_version_changed = 9
True if Workflow's Target Worker Deployment Version is different from its Pinned Version and the workflow is Pinned. Experimental.
int64 history_size_bytes = 5
Total history size in bytes, which the workflow might use to decide when to continue-as-new regardless of the suggestion. Note that history event count is just the event id of this event, so we don't include it explicitly here.
optional worker_version = 6
Version info of the worker to whom this task was dispatched. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
int64 build_id_redirect_counter = 7
Used by server internally to properly reapply build ID redirects to an execution when rebuilding it from events. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
message
message.proto:384Used in:
int64 scheduled_event_id = 1
The id of the `WORKFLOW_TASK_SCHEDULED` event this task corresponds to
int64 started_event_id = 2
The id of the `WORKFLOW_TASK_STARTED` event this task corresponds to
enums.v1.TimeoutType timeout_type = 3