Class: WorkerDeploymentVersionSummary

v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary

Represents a WorkerDeploymentVersionSummary.

Implements

• IWorkerDeploymentVersionSummary

Constructors

constructor

• new WorkerDeploymentVersionSummary(properties?): WorkerDeploymentVersionSummary

Constructs a new WorkerDeploymentVersionSummary.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentVersionSummary	Properties to set

Returns

WorkerDeploymentVersionSummary

Properties

createTime

• Optional createTime: null | ITimestamp

WorkerDeploymentVersionSummary createTime.

Implementation of

IWorkerDeploymentVersionSummary.createTime

---

currentSinceTime

• Optional currentSinceTime: null | ITimestamp

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

Implementation of

IWorkerDeploymentVersionSummary.currentSinceTime

---

deploymentVersion

• Optional deploymentVersion: null | IWorkerDeploymentVersion

Required.

Implementation of

IWorkerDeploymentVersionSummary.deploymentVersion

---

drainageInfo

• Optional drainageInfo: null | IVersionDrainageInfo

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

Implementation of

IWorkerDeploymentVersionSummary.drainageInfo

---

drainageStatus

• drainageStatus: VersionDrainageStatus

Deprecated. Use drainage_info instead.

Implementation of

IWorkerDeploymentVersionSummary.drainageStatus

---

firstActivationTime

• Optional firstActivationTime: null | ITimestamp

Timestamp when this version first became current or ramping.

Implementation of

IWorkerDeploymentVersionSummary.firstActivationTime

---

lastCurrentTime

• Optional lastCurrentTime: null | ITimestamp

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

Implementation of

IWorkerDeploymentVersionSummary.lastCurrentTime

---

lastDeactivationTime

• Optional lastDeactivationTime: null | ITimestamp

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

Implementation of

IWorkerDeploymentVersionSummary.lastDeactivationTime

---

rampingSinceTime

• Optional rampingSinceTime: null | ITimestamp

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. --)

Implementation of

IWorkerDeploymentVersionSummary.rampingSinceTime

---

routingUpdateTime

• Optional routingUpdateTime: null | ITimestamp

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

Implementation of

IWorkerDeploymentVersionSummary.routingUpdateTime

---

status

• status: WorkerDeploymentVersionStatus

The status of the Worker Deployment Version.

Implementation of

IWorkerDeploymentVersionSummary.status

---

version

• version: string

Deprecated. Use deployment_version.

Implementation of

IWorkerDeploymentVersionSummary.version

Methods

toJSON

▸ toJSON(): Object

Converts this WorkerDeploymentVersionSummary to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkerDeploymentVersionSummary

Creates a new WorkerDeploymentVersionSummary instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkerDeploymentVersionSummary	Properties to set

Returns

WorkerDeploymentVersionSummary

WorkerDeploymentVersionSummary instance

---

decode

▸ decode(reader, length?): WorkerDeploymentVersionSummary

Decodes a WorkerDeploymentVersionSummary message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

WorkerDeploymentVersionSummary

WorkerDeploymentVersionSummary

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkerDeploymentVersionSummary

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

WorkerDeploymentVersionSummary

WorkerDeploymentVersionSummary

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkerDeploymentVersionSummary	WorkerDeploymentVersionSummary message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkerDeploymentVersionSummary	WorkerDeploymentVersionSummary message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkerDeploymentVersionSummary

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkerDeploymentVersionSummary

WorkerDeploymentVersionSummary

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkerDeploymentVersionSummary

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	WorkerDeploymentVersionSummary	WorkerDeploymentVersionSummary
options?	IConversionOptions	Conversion options

Returns

Object

Plain object