Class: VersionDrainageInfo
deployment.v1.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. Experimental. Worker Deployments are experimental and might significantly change in the future.
Implements
Constructors
constructor
• new VersionDrainageInfo(properties?): VersionDrainageInfo
Constructs a new VersionDrainageInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IVersionDrainageInfo | Properties to set |
Returns
Properties
lastChangedTime
• Optional lastChangedTime: null | ITimestamp
Last time the drainage status changed.
Implementation of
IVersionDrainageInfo.lastChangedTime
lastCheckedTime
• Optional lastCheckedTime: null | ITimestamp
Last time the system checked for drainage of this version.
Implementation of
IVersionDrainageInfo.lastCheckedTime
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.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this VersionDrainageInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): VersionDrainageInfo
Creates a new VersionDrainageInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IVersionDrainageInfo | Properties to set |
Returns
VersionDrainageInfo instance
decode
▸ decode(reader, length?): VersionDrainageInfo
Decodes a VersionDrainageInfo 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
VersionDrainageInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): VersionDrainageInfo
Decodes a VersionDrainageInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
VersionDrainageInfo
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 VersionDrainageInfo message. Does not implicitly temporal.api.deployment.v1.VersionDrainageInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IVersionDrainageInfo | VersionDrainageInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified VersionDrainageInfo message, length delimited. Does not implicitly temporal.api.deployment.v1.VersionDrainageInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IVersionDrainageInfo | VersionDrainageInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): VersionDrainageInfo
Creates a VersionDrainageInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
VersionDrainageInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for VersionDrainageInfo
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 VersionDrainageInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | VersionDrainageInfo | VersionDrainageInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object