Skip to main content

Class: WorkerDeploymentInfo

A Worker Deployment (Deployment, for short) represents all workers serving a shared set of Task Queues. Typically, a Deployment represents one service or application. A Deployment contains multiple Deployment Versions, each representing a different version of workers. (see documentation of WorkerDeploymentVersionInfo) Deployment records are created in Temporal server automatically when their first poller arrives to the server.

Properties​

createTime?​

optional createTime?: $Properties | null

WorkerDeploymentInfo createTime.

lastModifierIdentity​

lastModifierIdentity: string

Identity of the last client who modified the configuration of this Deployment. Set to the identity value sent by APIs such as SetWorkerDeploymentCurrentVersion and SetWorkerDeploymentRampingVersion.

managerIdentity​

managerIdentity: string

Identity of the client that has the exclusive right to make changes to this Worker Deployment. Empty by default. If this is set, clients whose identity does not match manager_identity will not be able to make changes to this Worker Deployment. They can either set their own identity as the manager or unset the field to proceed.

name​

name: string

Identifies a Worker Deployment. Must be unique within the namespace.

routingConfig?​

optional routingConfig?: $Properties | null

WorkerDeploymentInfo routingConfig.

routingConfigUpdateState​

routingConfigUpdateState: RoutingConfigUpdateState

Indicates whether the routing_config has been fully propagated to all relevant task queues and their partitions.

versionSummaries​

versionSummaries: $Properties[]

Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be cleaned up automatically if all the following conditions meet:

  • It does not receive new executions (is not current or ramping)
  • It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
  • It is drained (see WorkerDeploymentVersionInfo.drainage_status)

Methods​

toJSON()​

toJSON(): object

Converts this WorkerDeploymentInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerDeploymentInfo & $Properties

Creates a new WorkerDeploymentInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentInfo & $Properties

WorkerDeploymentInfo instance

Call Signature​

static create(properties?): WorkerDeploymentInfo

Creates a new WorkerDeploymentInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentInfo

WorkerDeploymentInfo instance

decode()​

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

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

WorkerDeploymentInfo & $Properties

WorkerDeploymentInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerDeploymentInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerDeploymentInfo & $Properties

WorkerDeploymentInfo

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

Parameters​

message​

$Properties

WorkerDeploymentInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerDeploymentInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerDeploymentInfo

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

Parameters​

object​

Plain object

Returns​

WorkerDeploymentInfo

WorkerDeploymentInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerDeploymentInfo

WorkerDeploymentInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object