Class: WorkerDeploymentVersion
deployment.v1.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
▸ create(properties?): WorkerDeploymentVersion & $Properties
Creates a new WorkerDeploymentVersion instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkerDeploymentVersion & $Properties
WorkerDeploymentVersion instance
▸ create(properties?): WorkerDeploymentVersion
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkerDeploymentVersion & $Properties
Decodes a WorkerDeploymentVersion 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
WorkerDeploymentVersion & $Properties
WorkerDeploymentVersion
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerDeploymentVersion & $Properties
Decodes a WorkerDeploymentVersion message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified WorkerDeploymentVersion message. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentVersion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerDeploymentVersion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerDeploymentVersion message, length delimited. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentVersion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerDeploymentVersion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerDeploymentVersion
Creates a WorkerDeploymentVersion message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerDeploymentVersion
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkerDeploymentVersion message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerDeploymentVersion | WorkerDeploymentVersion |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object