Skip to main content

Class: UpdateWorkerConfigRequest

Represents an UpdateWorkerConfigRequest.

Properties​

identity​

identity: string

The identity of the client who initiated this request.

namespace​

namespace: string

Namespace this worker belongs to.

reason​

reason: string

Reason for sending worker command, can be used for audit purpose.

resourceId​

resourceId: string

Resource ID for routing. Contains the worker grouping key.

selector?​

optional selector?: $Properties | null

Defines which workers should receive this command.

updateMask?​

optional updateMask?: $Properties | null

Controls which fields from worker_config will be applied

workerConfig?​

optional workerConfig?: $Properties | null

Partial updates are accepted and controlled by update_mask. The worker configuration to set.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateWorkerConfigRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateWorkerConfigRequest & $Shape

Creates a new UpdateWorkerConfigRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

UpdateWorkerConfigRequest & $Shape

UpdateWorkerConfigRequest instance

Call Signature​

static create(properties?): UpdateWorkerConfigRequest

Creates a new UpdateWorkerConfigRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateWorkerConfigRequest

UpdateWorkerConfigRequest instance

decode()​

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

Decodes an UpdateWorkerConfigRequest 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​

UpdateWorkerConfigRequest & $Shape

UpdateWorkerConfigRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateWorkerConfigRequest & $Shape

Decodes an UpdateWorkerConfigRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateWorkerConfigRequest & $Shape

UpdateWorkerConfigRequest

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 UpdateWorkerConfigRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerConfigRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateWorkerConfigRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UpdateWorkerConfigRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateWorkerConfigRequest

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

Parameters​

object​

Plain object

Returns​

UpdateWorkerConfigRequest

UpdateWorkerConfigRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UpdateWorkerConfigRequest

UpdateWorkerConfigRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object