Skip to main content

Class: ShutdownWorkerRequest

Represents a ShutdownWorkerRequest.

Properties​

identity​

identity: string

ShutdownWorkerRequest identity.

namespace​

namespace: string

ShutdownWorkerRequest namespace.

reason​

reason: string

ShutdownWorkerRequest 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.

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.

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.

workerHeartbeat?​

optional workerHeartbeat?: $Properties | null

ShutdownWorkerRequest 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.

Methods​

toJSON()​

toJSON(): object

Converts this ShutdownWorkerRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ShutdownWorkerRequest & $Shape

Creates a new ShutdownWorkerRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ShutdownWorkerRequest & $Shape

ShutdownWorkerRequest instance

Call Signature​

static create(properties?): ShutdownWorkerRequest

Creates a new ShutdownWorkerRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ShutdownWorkerRequest

ShutdownWorkerRequest instance

decode()​

static decode(reader, length?): ShutdownWorkerRequest & $Shape

Decodes a ShutdownWorkerRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ShutdownWorkerRequest & $Shape

ShutdownWorkerRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ShutdownWorkerRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ShutdownWorkerRequest & $Shape

ShutdownWorkerRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

ShutdownWorkerRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ShutdownWorkerRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ShutdownWorkerRequest

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

Parameters​

object​

Plain object

Returns​

ShutdownWorkerRequest

ShutdownWorkerRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ShutdownWorkerRequest

ShutdownWorkerRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object