Class: DeploymentVersionTransition
workflow.v1.DeploymentVersionTransition
Holds information about ongoing transition of a workflow execution from one worker deployment version to another. Experimental. Might change in the future.
Properties
deploymentVersion
• Optional deploymentVersion: null | $Properties
The target Version of the transition. If nil, a so-far-versioned workflow is transitioning to unversioned workers.
version
• version: string
Deprecated. Use deployment_version.
Methods
toJSON
▸ toJSON(): Object
Converts this DeploymentVersionTransition to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeploymentVersionTransition & $Properties
Creates a new DeploymentVersionTransition instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DeploymentVersionTransition & $Properties
DeploymentVersionTransition instance
▸ create(properties?): DeploymentVersionTransition
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DeploymentVersionTransition & $Properties
Decodes a DeploymentVersionTransition 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
DeploymentVersionTransition & $Properties
DeploymentVersionTransition
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeploymentVersionTransition & $Properties
Decodes a DeploymentVersionTransition message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeploymentVersionTransition & $Properties
DeploymentVersionTransition
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 DeploymentVersionTransition message. Does not implicitly temporal.api.workflow.v1.DeploymentVersionTransition.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeploymentVersionTransition message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeploymentVersionTransition message, length delimited. Does not implicitly temporal.api.workflow.v1.DeploymentVersionTransition.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeploymentVersionTransition message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeploymentVersionTransition
Creates a DeploymentVersionTransition message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeploymentVersionTransition
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DeploymentVersionTransition message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeploymentVersionTransition | DeploymentVersionTransition |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object