Skip to main content

Interface: $Properties

Properties of a RespondWorkflowTaskCompletedRequest.

Extended by​

Properties​

binaryChecksum?​

optional binaryChecksum?: string | null

Deprecated. Use deployment_options instead. Worker process' unique binary id

capabilities?​

optional capabilities?: $Properties | null

All capabilities the SDK supports.

commands?​

optional commands?: $Properties[] | null

A list of commands generated when driving the workflow code in response to the new task

deployment?​

optional deployment?: $Properties | null

Deployment info of the worker that completed this task. Must be present if user has set WorkerDeploymentOptions regardless of versioning being enabled or not. Deprecated. Replaced with deployment_options.

deploymentOptions?​

optional deploymentOptions?: $Properties | null

Worker deployment options that user has set in the worker.

forceCreateNewWorkflowTask?​

optional forceCreateNewWorkflowTask?: boolean | null

Can be used to force creation of a new workflow task, even if no commands have resolved or one would not otherwise have been generated. This is used when the worker knows it is doing something useful, but cannot complete it within the workflow task timeout. Local activities which run for longer than the task timeout being the prime example.

identity?​

optional identity?: string | null

The identity of the worker/client

intermediatePage?​

optional intermediatePage?: boolean | null

True for non-final pages of a paginated workflow task completion. The final page's page_number tells the server how many intermediate pages (0..page_number-1) preceded it. May only be used when the namespace capability workflow_task_completion_pagination is true.

messages?​

optional messages?: $Properties[] | null

Protocol messages piggybacking on a WFT as a transport

meteringMetadata?​

optional meteringMetadata?: $Properties | null

Local usage data collected for metering

namespace?​

optional namespace?: string | null

RespondWorkflowTaskCompletedRequest namespace

pageNumber?​

optional pageNumber?: number | null

0-indexed page number when the workflow task completion is split across multiple requests ("pages"). 0 for single-page requests. May only be set to non-zero value when the namespace capability workflow_task_completion_pagination is true.

queryResults?​

optional queryResults?: {[k: string]: $Properties; } | null

Responses to the queries field in the task being responded to

resourceId?​

optional resourceId?: string | null

Resource ID for routing. Contains the workflow ID from the original task.

returnNewWorkflowTask?​

optional returnNewWorkflowTask?: boolean | null

If set, the worker wishes to immediately receive the next workflow task as a response to this completion. This can save on polling round-trips.

sdkMetadata?​

optional sdkMetadata?: $Properties | null

Data the SDK wishes to record for itself, but server need not interpret, and does not directly impact workflow state.

stickyAttributes?​

optional stickyAttributes?: $Properties | null

May be set by workers to indicate that the worker desires future tasks to be provided with incremental history on a sticky queue.

taskToken?​

optional taskToken?: Uint8Array<ArrayBufferLike> | null

The task token as received in PollWorkflowTaskQueueResponse

versioningBehavior?​

optional versioningBehavior?: VersioningBehavior | null

Versioning behavior of this workflow execution as set on the worker that completed this task. UNSPECIFIED means versioning is not enabled in the worker.

workerControlTaskQueue?​

optional workerControlTaskQueue?: string | null

A dedicated per-worker Nexus task queue on which the server sends control tasks (e.g. activity cancellation) to this specific worker instance.

workerInstanceKey?​

optional workerInstanceKey?: string | null

A unique key for this worker instance, used for tracking worker lifecycle. This is guaranteed to be unique, whereas identity is not guaranteed to be unique.

workerVersionStamp?​

optional workerVersionStamp?: $Properties | null

Version info of the worker who processed this task. This message's build_id field should always be set by SDKs. Workers opting into versioning will also set the use_versioning field to true. See message docstrings for more. Deprecated. Use deployment_options and versioning_behavior instead.