Class: WorkerDeploymentOptions

deployment.v1.WorkerDeploymentOptions

Worker Deployment options set in SDK that need to be sent to server in every poll. Experimental. Worker Deployments are experimental and might significantly change in the future.

Implements

• IWorkerDeploymentOptions

Constructors

constructor

• new WorkerDeploymentOptions(properties?): WorkerDeploymentOptions

Constructs a new WorkerDeploymentOptions.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentOptions	Properties to set

Returns

WorkerDeploymentOptions

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 identified by "<deployment_name>.<build_id>".

Implementation of

IWorkerDeploymentOptions.buildId

---

deploymentName

• deploymentName: string

Required. Worker Deployment name.

Implementation of

IWorkerDeploymentOptions.deploymentName

---

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 identified by "<deployment_name>.<build_id>".

Implementation of

IWorkerDeploymentOptions.workerVersioningMode

Methods

toJSON

▸ toJSON(): Object

Converts this WorkerDeploymentOptions to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkerDeploymentOptions

Creates a new WorkerDeploymentOptions instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentOptions	Properties to set

Returns

WorkerDeploymentOptions

WorkerDeploymentOptions instance

---

decode

▸ decode(reader, length?): WorkerDeploymentOptions

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

WorkerDeploymentOptions

WorkerDeploymentOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkerDeploymentOptions

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

Parameters

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

Returns

WorkerDeploymentOptions

WorkerDeploymentOptions

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

Parameters

Name	Type	Description
message	IWorkerDeploymentOptions	WorkerDeploymentOptions message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkerDeploymentOptions	WorkerDeploymentOptions message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkerDeploymentOptions

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkerDeploymentOptions

WorkerDeploymentOptions

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkerDeploymentOptions

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 WorkerDeploymentOptions message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	WorkerDeploymentOptions	WorkerDeploymentOptions
options?	IConversionOptions	Conversion options

Returns

Object

Plain object