Class: WorkerDeploymentVersionSummary
v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary
Represents a WorkerDeploymentVersionSummary.
Properties
computeConfig
• Optional computeConfig: null | $Properties
WorkerDeploymentVersionSummary computeConfig.
computeStatus
• Optional computeStatus: null | $Properties
ComputeStatus represents compute-related configuration and healthchecks.
createTime
• Optional createTime: null | $Properties
WorkerDeploymentVersionSummary createTime.
currentSinceTime
• Optional currentSinceTime: null | $Properties
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: null | $Properties
Required.
drainageInfo
• Optional drainageInfo: null | $Properties
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: null | $Properties
Timestamp when this version first became current or ramping.
lastCurrentTime
• Optional lastCurrentTime: null | $Properties
Timestamp when this version last became current. Can be used to determine whether a version has ever been Current.
lastDeactivationTime
• Optional lastDeactivationTime: null | $Properties
Timestamp when this version last stopped being current or ramping. Cleared if the version becomes current or ramping again.
rampingSinceTime
• Optional rampingSinceTime: null | $Properties
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: null | $Properties
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
▸ create(properties?): WorkerDeploymentVersionSummary & $Properties
Creates a new WorkerDeploymentVersionSummary instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkerDeploymentVersionSummary & $Properties
WorkerDeploymentVersionSummary instance
▸ create(properties?): WorkerDeploymentVersionSummary
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
WorkerDeploymentVersionSummary
decode
▸ decode(reader, length?): WorkerDeploymentVersionSummary & $Properties
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 & $Properties
WorkerDeploymentVersionSummary
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerDeploymentVersionSummary & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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