Skip to main content

Class: VersionDrainageInfo

Information about workflow drainage to help the user determine when it is safe to decommission a Version. Not present while version is current or ramping.

Properties​

lastChangedTime?​

optional lastChangedTime?: $Properties | null

Last time the drainage status changed.

lastCheckedTime?​

optional lastCheckedTime?: $Properties | null

Last time the system checked for drainage of this version.

status​

status: VersionDrainageStatus

Set to DRAINING when the version first stops accepting new executions (is no longer current or ramping). Set to DRAINED when no more open pinned workflows exist on this version.

Methods​

toJSON()​

toJSON(): object

Converts this VersionDrainageInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): VersionDrainageInfo & $Properties

Creates a new VersionDrainageInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

VersionDrainageInfo & $Properties

VersionDrainageInfo instance

Call Signature​

static create(properties?): VersionDrainageInfo

Creates a new VersionDrainageInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

VersionDrainageInfo

VersionDrainageInfo instance

decode()​

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

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

VersionDrainageInfo & $Properties

VersionDrainageInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): VersionDrainageInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

VersionDrainageInfo & $Properties

VersionDrainageInfo

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

Parameters​

message​

$Properties

VersionDrainageInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

VersionDrainageInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): VersionDrainageInfo

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

Parameters​

object​

Plain object

Returns​

VersionDrainageInfo

VersionDrainageInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

VersionDrainageInfo

VersionDrainageInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object