Skip to main content

Interface: IShutdownWorkerRequest

Properties of a ShutdownWorkerRequest.

Extends​

Properties​

identity?​

optional identity?: string | null

ShutdownWorkerRequest identity

Inherited from​

$Properties.identity

namespace?​

optional namespace?: string | null

ShutdownWorkerRequest namespace

Inherited from​

$Properties.namespace

reason?​

optional reason?: string | null

ShutdownWorkerRequest reason

Inherited from​

$Properties.reason

stickyTaskQueue?​

optional stickyTaskQueue?: string | null

sticky_task_queue may not always be populated. We want to ensure all workers send a shutdown request to update worker state for heartbeating, as well as cancel pending poll calls early, instead of waiting for timeouts.

Inherited from​

$Properties.stickyTaskQueue

taskQueue?​

optional taskQueue?: string | null

Task queue name the worker is polling on. This allows server to cancel all outstanding poll RPC calls from SDK. This avoids a race condition that can lead to tasks being lost.

Inherited from​

$Properties.taskQueue

taskQueueTypes?​

optional taskQueueTypes?: TaskQueueType[] | null

Task queue types that help server cancel outstanding poll RPC calls from SDK. This avoids a race condition that can lead to tasks being lost.

Inherited from​

$Properties.taskQueueTypes

workerHeartbeat?​

optional workerHeartbeat?: $Properties | null

ShutdownWorkerRequest workerHeartbeat

Inherited from​

$Properties.workerHeartbeat

workerInstanceKey?​

optional workerInstanceKey?: string | null

Technically this is also sent in the WorkerHeartbeat, but since worker heartbeating can be turned off, this needs to be a separate, top-level field.

Inherited from​

$Properties.workerInstanceKey