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