Skip to main content

Class: WorkerDeploymentOptions

Worker Deployment options set in SDK that need to be sent to server in every poll.

Properties​

buildId​

buildId: string

The Build ID of the worker. Required when worker_versioning_mode==VERSIONED, in which case, the worker will be part of a Deployment Version.

deploymentName​

deploymentName: string

Required when worker_versioning_mode==VERSIONED.

workerVersioningMode​

workerVersioningMode: WorkerVersioningMode

Required. Versioning Mode for this worker. Must be the same for all workers with the same deployment_name and build_id combination, across all Task Queues. When worker_versioning_mode==VERSIONED, the worker will be part of a Deployment Version.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerDeploymentOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerDeploymentOptions & $Properties

Creates a new WorkerDeploymentOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentOptions & $Properties

WorkerDeploymentOptions instance

Call Signature​

static create(properties?): WorkerDeploymentOptions

Creates a new WorkerDeploymentOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentOptions

WorkerDeploymentOptions instance

decode()​

static decode(reader, length?): WorkerDeploymentOptions & $Properties

Decodes a WorkerDeploymentOptions 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​

WorkerDeploymentOptions & $Properties

WorkerDeploymentOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerDeploymentOptions & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerDeploymentOptions & $Properties

WorkerDeploymentOptions

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

Parameters​

message​

$Properties

WorkerDeploymentOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerDeploymentOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerDeploymentOptions

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

Parameters​

object​

Plain object

Returns​

WorkerDeploymentOptions

WorkerDeploymentOptions

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerDeploymentOptions

WorkerDeploymentOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object