Skip to main content

Class: DeploymentListInfo

DeploymentListInfo is an abbreviated set of fields from DeploymentInfo that's returned in ListDeployments. Deprecated.

Properties​

createTime?​

optional createTime?: $Properties | null

DeploymentListInfo createTime.

deployment?​

optional deployment?: $Properties | null

DeploymentListInfo deployment.

isCurrent​

isCurrent: boolean

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

Methods​

toJSON()​

toJSON(): object

Converts this DeploymentListInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeploymentListInfo & $Properties

Creates a new DeploymentListInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeploymentListInfo & $Properties

DeploymentListInfo instance

Call Signature​

static create(properties?): DeploymentListInfo

Creates a new DeploymentListInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeploymentListInfo

DeploymentListInfo instance

decode()​

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

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

DeploymentListInfo & $Properties

DeploymentListInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeploymentListInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeploymentListInfo & $Properties

DeploymentListInfo

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

Parameters​

message​

$Properties

DeploymentListInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeploymentListInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeploymentListInfo

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

Parameters​

object​

Plain object

Returns​

DeploymentListInfo

DeploymentListInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeploymentListInfo

DeploymentListInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object