Skip to main content

Class: DeploymentInfo

DeploymentInfo holds information about a deployment. Deployment information is tracked automatically by server as soon as the first poll from that deployment reaches the server. There can be multiple task queue workers in a single deployment which are listed in this message. Deprecated.

Properties​

createTime?​

optional createTime?: $Properties | null

DeploymentInfo createTime.

deployment?​

optional deployment?: $Properties | null

DeploymentInfo deployment.

isCurrent​

isCurrent: boolean

If this deployment is the current deployment of its deployment series.

metadata​

metadata: object

A user-defined set of key-values. Can be updated as part of write operations to the deployment, such as SetCurrentDeployment.

Index Signature​

[k: string]: $Properties

taskQueueInfos​

taskQueueInfos: $Properties[]

DeploymentInfo taskQueueInfos.

Methods​

toJSON()​

toJSON(): object

Converts this DeploymentInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeploymentInfo & $Properties

Creates a new DeploymentInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeploymentInfo & $Properties

DeploymentInfo instance

Call Signature​

static create(properties?): DeploymentInfo

Creates a new DeploymentInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeploymentInfo

DeploymentInfo instance

decode()​

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

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

DeploymentInfo & $Properties

DeploymentInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeploymentInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeploymentInfo & $Properties

DeploymentInfo

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

Parameters​

message​

$Properties

DeploymentInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeploymentInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeploymentInfo

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

Parameters​

object​

Plain object

Returns​

DeploymentInfo

DeploymentInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeploymentInfo

DeploymentInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object