Class: ShutdownWorkerRequest

workflowservice.v1.ShutdownWorkerRequest

Represents a ShutdownWorkerRequest.

Implements

• IShutdownWorkerRequest

Constructors

constructor

• new ShutdownWorkerRequest(properties?): ShutdownWorkerRequest

Constructs a new ShutdownWorkerRequest.

Parameters

Name	Type	Description
properties?	IShutdownWorkerRequest	Properties to set

Returns

ShutdownWorkerRequest

Properties

identity

• identity: string

ShutdownWorkerRequest identity.

Implementation of

IShutdownWorkerRequest.identity

---

namespace

• namespace: string

ShutdownWorkerRequest namespace.

Implementation of

IShutdownWorkerRequest.namespace

---

reason

• reason: string

ShutdownWorkerRequest reason.

Implementation of

IShutdownWorkerRequest.reason

---

stickyTaskQueue

• stickyTaskQueue: 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.

Implementation of

IShutdownWorkerRequest.stickyTaskQueue

---

taskQueue

• taskQueue: 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.

Implementation of

IShutdownWorkerRequest.taskQueue

---

taskQueueTypes

• taskQueueTypes: 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.

Implementation of

IShutdownWorkerRequest.taskQueueTypes

---

workerHeartbeat

• Optional workerHeartbeat: null | IWorkerHeartbeat

ShutdownWorkerRequest workerHeartbeat.

Implementation of

IShutdownWorkerRequest.workerHeartbeat

---

workerInstanceKey

• workerInstanceKey: 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.

Implementation of

IShutdownWorkerRequest.workerInstanceKey

Methods

toJSON

▸ toJSON(): Object

Converts this ShutdownWorkerRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): ShutdownWorkerRequest

Creates a new ShutdownWorkerRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IShutdownWorkerRequest	Properties to set

Returns

ShutdownWorkerRequest

ShutdownWorkerRequest instance

---

decode

▸ decode(reader, length?): ShutdownWorkerRequest

Decodes a ShutdownWorkerRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

ShutdownWorkerRequest

ShutdownWorkerRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): ShutdownWorkerRequest

Decodes a ShutdownWorkerRequest message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

ShutdownWorkerRequest

ShutdownWorkerRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

Encodes the specified ShutdownWorkerRequest message. Does not implicitly temporal.api.workflowservice.v1.ShutdownWorkerRequest.verify|verify messages.

Parameters

Name	Type	Description
message	IShutdownWorkerRequest	ShutdownWorkerRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified ShutdownWorkerRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ShutdownWorkerRequest.verify|verify messages.

Parameters

Name	Type	Description
message	IShutdownWorkerRequest	ShutdownWorkerRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): ShutdownWorkerRequest

Creates a ShutdownWorkerRequest message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

ShutdownWorkerRequest

ShutdownWorkerRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ShutdownWorkerRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

Creates a plain object from a ShutdownWorkerRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	ShutdownWorkerRequest	ShutdownWorkerRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object