Skip to main content

Class: Deployment

Deployment identifies a deployment of Temporal workers. The combination of deployment series name + build ID serves as the identifier. User can use WorkerDeploymentOptions in their worker programs to specify these values. Deprecated.

Properties​

buildId​

buildId: string

Build ID changes with each version of the worker when the worker program code and/or config changes.

seriesName​

seriesName: string

Different versions of the same worker service/application are related together by having a shared series name. Out of all deployments of a series, one can be designated as the current deployment, which receives new workflow executions and new tasks of workflows with VERSIONING_BEHAVIOR_AUTO_UPGRADE versioning behavior.

Methods​

toJSON()​

toJSON(): object

Converts this Deployment to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Deployment & $Properties

Creates a new Deployment instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Deployment & $Properties

Deployment instance

Call Signature​

static create(properties?): Deployment

Creates a new Deployment instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Deployment

Deployment instance

decode()​

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

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

Deployment & $Properties

Deployment

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Deployment & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Deployment & $Properties

Deployment

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

Parameters​

message​

$Properties

Deployment message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Deployment message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Deployment

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

Parameters​

object​

Plain object

Returns​

Deployment

Deployment

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Deployment

Deployment

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object