Skip to main content

Class: 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.

Properties​

computeConfig?​

optional computeConfig?: $Properties | null

Optional. Contains the new worker compute configuration for the Worker Deployment. Used for worker scale management.

createTime?​

optional createTime?: $Properties | null

WorkerDeploymentVersionInfo createTime.

currentSinceTime?​

optional currentSinceTime?: $Properties | null

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

deploymentName​

deploymentName: string

Deprecated. User deployment_version.deployment_name.

deploymentVersion?​

optional deploymentVersion?: $Properties | null

Required.

drainageInfo?​

optional drainageInfo?: $Properties | null

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

firstActivationTime?​

optional firstActivationTime?: $Properties | null

Timestamp when this version first became current or ramping.

lastCurrentTime?​

optional lastCurrentTime?: $Properties | null

Timestamp when this version last became current. Can be used to determine whether a version has ever been Current.

lastDeactivationTime?​

optional lastDeactivationTime?: $Properties | null

Timestamp when this version last stopped being current or ramping. Cleared if the version becomes current or ramping again.

lastModifierIdentity​

lastModifierIdentity: string

Identity of the last client who modified the configuration of this Version. As of now, this field only covers changes through the following APIs:

  • CreateWorkerDeploymentVersion
  • UpdateWorkerDeploymentVersionComputeConfig
  • UpdateWorkerDeploymentVersionMetadata

metadata?​

optional metadata?: $Properties | null

Arbitrary user-provided metadata attached to this version.

rampingSinceTime?​

optional rampingSinceTime?: $Properties | null

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

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.

routingChangedTime?​

optional routingChangedTime?: $Properties | null

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

status​

status: WorkerDeploymentVersionStatus

The status of the Worker Deployment Version.

taskQueueInfos​

taskQueueInfos: $Properties[]

All the Task Queues that have ever polled from this Deployment version. Deprecated. Use version_task_queues in DescribeWorkerDeploymentVersionResponse instead.

version​

version: string

Deprecated. Use deployment_version.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerDeploymentVersionInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerDeploymentVersionInfo & $Properties

Creates a new WorkerDeploymentVersionInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentVersionInfo & $Properties

WorkerDeploymentVersionInfo instance

Call Signature​

static create(properties?): WorkerDeploymentVersionInfo

Creates a new WorkerDeploymentVersionInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentVersionInfo

WorkerDeploymentVersionInfo instance

decode()​

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

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

WorkerDeploymentVersionInfo & $Properties

WorkerDeploymentVersionInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerDeploymentVersionInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerDeploymentVersionInfo & $Properties

WorkerDeploymentVersionInfo

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

Parameters​

message​

$Properties

WorkerDeploymentVersionInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerDeploymentVersionInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerDeploymentVersionInfo

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

WorkerDeploymentVersionInfo

WorkerDeploymentVersionInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerDeploymentVersionInfo

WorkerDeploymentVersionInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object