Class: WorkerDeploymentVersion
A Worker Deployment Version (Version, for short) represents a version of workers within a Worker Deployment. (see documentation of WorkerDeploymentVersionInfo) Version records are created in Temporal server automatically when their first poller arrives to the server. Experimental. Worker Deployment Versions are experimental and might significantly change in the future.
Properties
buildId
buildId:
string
A unique identifier for this Version within the Deployment it is a part of.
Not necessarily unique within the namespace.
The combination of deployment_name and build_id uniquely identifies this
Version within the namespace, because Deployment names are unique within a namespace.
deploymentName
deploymentName:
string
Identifies the Worker Deployment this Version is part of.
Methods
toJSON()
toJSON():
object
Converts this WorkerDeploymentVersion to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):WorkerDeploymentVersion&$Properties
Creates a new WorkerDeploymentVersion instance using the specified properties.
Parameters
properties?
Properties to set
Returns
WorkerDeploymentVersion & $Properties
WorkerDeploymentVersion instance
Call Signature
staticcreate(properties?):WorkerDeploymentVersion
Creates a new WorkerDeploymentVersion instance using the specified properties.
Parameters
properties?
Properties to set
Returns
WorkerDeploymentVersion
WorkerDeploymentVersion instance
decode()
staticdecode(reader,length?):WorkerDeploymentVersion&$Properties
Decodes a WorkerDeploymentVersion 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
WorkerDeploymentVersion & $Properties
WorkerDeploymentVersion
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):WorkerDeploymentVersion&$Properties
Decodes a WorkerDeploymentVersion message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
WorkerDeploymentVersion & $Properties
WorkerDeploymentVersion
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 WorkerDeploymentVersion message. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentVersion.verify|verify messages.
Parameters
message
WorkerDeploymentVersion message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified WorkerDeploymentVersion message, length delimited. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentVersion.verify|verify messages.
Parameters
message
WorkerDeploymentVersion message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):WorkerDeploymentVersion
Creates a WorkerDeploymentVersion message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
WorkerDeploymentVersion
WorkerDeploymentVersion
toObject()
statictoObject(message,options?):object
Creates a plain object from a WorkerDeploymentVersion message. Also converts values to other types if specified.
Parameters
message
WorkerDeploymentVersion
WorkerDeploymentVersion
options?
IConversionOptions
Conversion options
Returns
object
Plain object