Skip to main content

Class: WorkerDeploymentVersionSummary

Represents a WorkerDeploymentVersionSummary.

Properties​

computeConfig?​

optional computeConfig?: $Properties | null

WorkerDeploymentVersionSummary computeConfig.

computeStatus?​

optional computeStatus?: $Properties | null

ComputeStatus represents compute-related configuration and healthchecks.

createTime?​

optional createTime?: $Properties | null

WorkerDeploymentVersionSummary createTime.

currentSinceTime?​

optional currentSinceTime?: $Properties | null

Unset if not current. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)

deploymentVersion?​

optional deploymentVersion?: $Properties | null

Required.

drainageInfo?​

optional drainageInfo?: $Properties | null

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

drainageStatus​

drainageStatus: VersionDrainageStatus

Deprecated. Use drainage_info instead.

firstActivationTime?​

optional firstActivationTime?: $Properties | null

Timestamp when this version first became current or ramping.

lastCurrentTime?​

optional lastCurrentTime?: $Properties | null

Timestamp when this version last became current. Can be used to determine whether a version has ever been Current.

lastDeactivationTime?​

optional lastDeactivationTime?: $Properties | null

Timestamp when this version last stopped being current or ramping. Cleared if the version becomes current or ramping again.

rampingSinceTime?​

optional rampingSinceTime?: $Properties | null

Unset if not ramping. Updated when the version first starts ramping, not on each ramp change. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)

routingUpdateTime?​

optional routingUpdateTime?: $Properties | null

Last time current_since_time, ramping_since_time, or ramp_percentage` of this version changed.

status​

status: WorkerDeploymentVersionStatus

The status of the Worker Deployment Version.

version​

version: string

Deprecated. Use deployment_version.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerDeploymentVersionSummary to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerDeploymentVersionSummary & $Properties

Creates a new WorkerDeploymentVersionSummary instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentVersionSummary & $Properties

WorkerDeploymentVersionSummary instance

Call Signature​

static create(properties?): WorkerDeploymentVersionSummary

Creates a new WorkerDeploymentVersionSummary instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerDeploymentVersionSummary

WorkerDeploymentVersionSummary instance

decode()​

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

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

WorkerDeploymentVersionSummary & $Properties

WorkerDeploymentVersionSummary

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerDeploymentVersionSummary & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerDeploymentVersionSummary & $Properties

WorkerDeploymentVersionSummary

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

Parameters​

message​

$Properties

WorkerDeploymentVersionSummary message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerDeploymentVersionSummary message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerDeploymentVersionSummary

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

Parameters​

object​

Plain object

Returns​

WorkerDeploymentVersionSummary

WorkerDeploymentVersionSummary

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerDeploymentVersionSummary

WorkerDeploymentVersionSummary

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object