Skip to main content

Class: DeploymentVersionTransition

Holds information about ongoing transition of a workflow execution from one worker deployment version to another. Experimental. Might change in the future.

Properties​

deploymentVersion?​

optional deploymentVersion?: $Properties | null

The target Version of the transition. If nil, a so-far-versioned workflow is transitioning to unversioned workers.

version​

version: string

Deprecated. Use deployment_version.

Methods​

toJSON()​

toJSON(): object

Converts this DeploymentVersionTransition to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeploymentVersionTransition & $Properties

Creates a new DeploymentVersionTransition instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeploymentVersionTransition & $Properties

DeploymentVersionTransition instance

Call Signature​

static create(properties?): DeploymentVersionTransition

Creates a new DeploymentVersionTransition instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeploymentVersionTransition

DeploymentVersionTransition instance

decode()​

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

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

DeploymentVersionTransition & $Properties

DeploymentVersionTransition

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeploymentVersionTransition & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeploymentVersionTransition & $Properties

DeploymentVersionTransition

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

Parameters​

message​

$Properties

DeploymentVersionTransition message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeploymentVersionTransition message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeploymentVersionTransition

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

Parameters​

object​

Plain object

Returns​

DeploymentVersionTransition

DeploymentVersionTransition

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeploymentVersionTransition

DeploymentVersionTransition

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object