Interface: IShutdownWorkerRequest

workflowservice.v1.IShutdownWorkerRequest

Properties of a ShutdownWorkerRequest.

Implemented by

• ShutdownWorkerRequest

Properties

identity

• Optional identity: null | string

ShutdownWorkerRequest identity

---

namespace

• Optional namespace: null | string

ShutdownWorkerRequest namespace

---

reason

• Optional reason: null | string

ShutdownWorkerRequest reason

---

stickyTaskQueue

• Optional stickyTaskQueue: null | string

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.

---

taskQueue

• Optional taskQueue: null | string

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.

---

taskQueueTypes

• Optional taskQueueTypes: null | TaskQueueType[]

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.

---

workerHeartbeat

• Optional workerHeartbeat: null | IWorkerHeartbeat

ShutdownWorkerRequest workerHeartbeat

---

workerInstanceKey

• Optional workerInstanceKey: null | string

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.