Interface: IWorkflowTaskStartedEventAttributes
history.v1.IWorkflowTaskStartedEventAttributes
Properties of a WorkflowTaskStartedEventAttributes.
Implemented by
Properties
buildIdRedirectCounter
• Optional buildIdRedirectCounter: null | Long
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]
historySizeBytes
• Optional historySizeBytes: null | Long
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.
identity
• Optional identity: null | string
Identity of the worker who picked up this task
requestId
• Optional requestId: null | string
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.
scheduledEventId
• Optional scheduledEventId: null | Long
The id of the WORKFLOW_TASK_SCHEDULED event this task corresponds to
suggestContinueAsNew
• Optional suggestContinueAsNew: null | boolean
True if this workflow should continue-as-new soon. See suggest_continue_as_new_reasons for why.
suggestContinueAsNewReasons
• Optional suggestContinueAsNewReasons: null | SuggestContinueAsNewReason[]
The reason(s) that suggest_continue_as_new is true, if it is. Unset if suggest_continue_as_new is false.
targetWorkerDeploymentVersionChanged
• Optional targetWorkerDeploymentVersionChanged: null | boolean
True if Workflow's Target Worker Deployment Version is different from its Pinned Version and the workflow is Pinned. Experimental.
workerVersion
• Optional workerVersion: null | IWorkerVersionStamp
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]