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.
Implements
Constructors
constructor
• new WorkerDeploymentVersion(properties?): WorkerDeploymentVersion
Constructs a new WorkerDeploymentVersion.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerDeploymentVersion | Properties to set |
Returns
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.
Implementation of
IWorkerDeploymentVersion.buildId
deploymentName
• deploymentName: string
Identifies the Worker Deployment this Version is part of.
Implementation of
IWorkerDeploymentVersion.deploymentName
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerDeploymentVersion to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerDeploymentVersion
Creates a new WorkerDeploymentVersion instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkerDeploymentVersion | Properties to set |
Returns
WorkerDeploymentVersion instance
decode
▸ decode(reader, length?): WorkerDeploymentVersion
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerDeploymentVersion
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
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 | IWorkerDeploymentVersion | 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 | IWorkerDeploymentVersion | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkerDeploymentVersion
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
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