Class: WorkerDeploymentVersionInfo

deployment.v1.WorkerDeploymentVersionInfo

A Worker Deployment Version (Version, for short) represents all workers of the same code and config within a Deployment. Workers of the same Version are expected to behave exactly the same so when executions move between them there are no non-determinism issues. Worker Deployment Versions are created in Temporal server automatically when their first poller arrives to the server. Experimental. Worker Deployments are experimental and might significantly change in the future.

Implements

• IWorkerDeploymentVersionInfo

Constructors

constructor

• new WorkerDeploymentVersionInfo(properties?): WorkerDeploymentVersionInfo

Constructs a new WorkerDeploymentVersionInfo.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentVersionInfo	Properties to set

Returns

WorkerDeploymentVersionInfo

Properties

createTime

• Optional createTime: null | ITimestamp

WorkerDeploymentVersionInfo createTime.

Implementation of

IWorkerDeploymentVersionInfo.createTime

---

currentSinceTime

• Optional currentSinceTime: null | ITimestamp

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --) Nil if not current.

Implementation of

IWorkerDeploymentVersionInfo.currentSinceTime

---

deploymentName

• deploymentName: string

WorkerDeploymentVersionInfo deploymentName.

Implementation of

IWorkerDeploymentVersionInfo.deploymentName

---

drainageInfo

• Optional drainageInfo: null | IVersionDrainageInfo

Helps user determine when it is safe to decommission the workers of this Version. Not present when version is current or ramping. Current limitations:

• Not supported for Unversioned mode.
• Periodically refreshed, may have delays up to few minutes (consult the last_checked_time value).
• Refreshed only when version is not current or ramping AND the status is not "drained" yet.
• Once the status is changed to "drained", it is not changed until the Version becomes Current or Ramping again, at which time the drainage info is cleared. This means if the Version is "drained" but new workflows are sent to it via Pinned Versioning Override, the status does not account for those Pinned-override executions and remains "drained".

Implementation of

IWorkerDeploymentVersionInfo.drainageInfo

---

metadata

• Optional metadata: null | IVersionMetadata

Arbitrary user-provided metadata attached to this version.

Implementation of

IWorkerDeploymentVersionInfo.metadata

---

rampPercentage

• rampPercentage: number

Range: [0, 100]. Must be zero if the version is not ramping (i.e. ramping_since_time is nil). Can be in the range [0, 100] if the version is ramping.

Implementation of

IWorkerDeploymentVersionInfo.rampPercentage

---

rampingSinceTime

• Optional rampingSinceTime: null | ITimestamp

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --) Nil if not ramping. Updated when the version first starts ramping, not on each ramp change.

Implementation of

IWorkerDeploymentVersionInfo.rampingSinceTime

---

routingChangedTime

• Optional routingChangedTime: null | ITimestamp

Last time current_since_time, ramping_since_time, or ramp_percentage` of this version changed.

Implementation of

IWorkerDeploymentVersionInfo.routingChangedTime

---

taskQueueInfos

• taskQueueInfos: IVersionTaskQueueInfo[]

All the Task Queues that have ever polled from this Deployment version.

Implementation of

IWorkerDeploymentVersionInfo.taskQueueInfos

---

version

• version: string

The fully-qualified string representation of the version, in the form "<deployment_name>.<build_id>".

Implementation of

IWorkerDeploymentVersionInfo.version

Methods

toJSON

▸ toJSON(): Object

Converts this WorkerDeploymentVersionInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkerDeploymentVersionInfo

Creates a new WorkerDeploymentVersionInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentVersionInfo	Properties to set

Returns

WorkerDeploymentVersionInfo

WorkerDeploymentVersionInfo instance

---

decode

▸ decode(reader, length?): WorkerDeploymentVersionInfo

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

WorkerDeploymentVersionInfo

WorkerDeploymentVersionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkerDeploymentVersionInfo

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

Parameters

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

Returns

WorkerDeploymentVersionInfo

WorkerDeploymentVersionInfo

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

Parameters

Name	Type	Description
message	IWorkerDeploymentVersionInfo	WorkerDeploymentVersionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkerDeploymentVersionInfo	WorkerDeploymentVersionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkerDeploymentVersionInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkerDeploymentVersionInfo

WorkerDeploymentVersionInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkerDeploymentVersionInfo

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

Parameters

Name	Type	Description
message	WorkerDeploymentVersionInfo	WorkerDeploymentVersionInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object