Class: DeploymentTransition
Holds information about ongoing transition of a workflow execution from one deployment to another. Deprecated. Use DeploymentVersionTransition.
Properties
deployment?
optionaldeployment?:$Properties|null
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()
Call Signature
staticcreate(properties?):DeploymentTransition&$Properties
Creates a new DeploymentTransition instance using the specified properties.
Parameters
properties?
Properties to set
Returns
DeploymentTransition & $Properties
DeploymentTransition instance
Call Signature
staticcreate(properties?):DeploymentTransition
Creates a new DeploymentTransition instance using the specified properties.
Parameters
properties?
Properties to set
Returns
DeploymentTransition
DeploymentTransition instance
decode()
staticdecode(reader,length?):DeploymentTransition&$Properties
Decodes a DeploymentTransition message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | 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()
staticdecodeDelimited(reader):DeploymentTransition&$Properties
Decodes a DeploymentTransition message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | 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()
staticencode(message,writer?):Writer
Encodes the specified DeploymentTransition message. Does not implicitly temporal.api.workflow.v1.DeploymentTransition.verify|verify messages.
Parameters
message
DeploymentTransition message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified DeploymentTransition message, length delimited. Does not implicitly temporal.api.workflow.v1.DeploymentTransition.verify|verify messages.
Parameters
message
DeploymentTransition message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):DeploymentTransition
Creates a DeploymentTransition message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
DeploymentTransition
DeploymentTransition
toObject()
statictoObject(message,options?):object
Creates a plain object from a DeploymentTransition message. Also converts values to other types if specified.
Parameters
message
DeploymentTransition
DeploymentTransition
options?
IConversionOptions
Conversion options
Returns
object
Plain object