Class: Deployment
deployment.v1.Deployment
Deployment identifies a deployment of Temporal workers. The combination of deployment series
name + build ID serves as the identifier. User can use WorkerDeploymentOptions in their worker
programs to specify these values.
Implements
Constructors
constructor
• new Deployment(properties?): Deployment
Constructs a new Deployment.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeployment | Properties to set |
Returns
Properties
buildId
• buildId: string
Build ID changes with each version of the worker when the worker program code and/or config changes.
Implementation of
seriesName
• seriesName: string
Different versions of the same worker service/application are related together by having a
shared series name.
Out of all deployments of a series, one can be designated as the current deployment, which
receives new workflow executions and new tasks of workflows with
VERSIONING_BEHAVIOR_AUTO_UPGRADE versioning behavior.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Deployment to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Deployment
Creates a new Deployment instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeployment | Properties to set |
Returns
Deployment instance
decode
▸ decode(reader, length?): Deployment
Decodes a Deployment 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
Deployment
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Deployment
Decodes a Deployment message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Deployment
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 Deployment message. Does not implicitly temporal.api.deployment.v1.Deployment.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeployment | Deployment message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Deployment message, length delimited. Does not implicitly temporal.api.deployment.v1.Deployment.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeployment | Deployment message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Deployment
Creates a Deployment message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Deployment
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Deployment
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 Deployment message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Deployment | Deployment |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object