Class: WorkerDeploymentInfo
deployment.v1.WorkerDeploymentInfo
A Worker Deployment (Deployment, for short) represents all workers serving a shared set of Task Queues. Typically, a Deployment represents one service or application. A Deployment contains multiple Deployment Versions, each representing a different version of workers. (see documentation of WorkerDeploymentVersionInfo) Deployment records are created in Temporal server automatically when their first poller arrives to the server.
Properties
createTime
• Optional createTime: null | $Properties
WorkerDeploymentInfo createTime.
lastModifierIdentity
• lastModifierIdentity: string
Identity of the last client who modified the configuration of this Deployment. Set to the
identity value sent by APIs such as SetWorkerDeploymentCurrentVersion and
SetWorkerDeploymentRampingVersion.
managerIdentity
• managerIdentity: string
Identity of the client that has the exclusive right to make changes to this Worker Deployment.
Empty by default.
If this is set, clients whose identity does not match manager_identity will not be able to make changes
to this Worker Deployment. They can either set their own identity as the manager or unset the field to proceed.
name
• name: string
Identifies a Worker Deployment. Must be unique within the namespace.
routingConfig
• Optional routingConfig: null | $Properties
WorkerDeploymentInfo routingConfig.
routingConfigUpdateState
• routingConfigUpdateState: RoutingConfigUpdateState
Indicates whether the routing_config has been fully propagated to all relevant task queues and their partitions.
versionSummaries
• versionSummaries: $Properties[]
Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be cleaned up automatically if all the following conditions meet:
- It does not receive new executions (is not current or ramping)
- It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
- It is drained (see WorkerDeploymentVersionInfo.drainage_status)
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerDeploymentInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerDeploymentInfo & $Properties
Creates a new WorkerDeploymentInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkerDeploymentInfo & $Properties
WorkerDeploymentInfo instance
▸ create(properties?): WorkerDeploymentInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkerDeploymentInfo & $Properties
Decodes a WorkerDeploymentInfo 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
WorkerDeploymentInfo & $Properties
WorkerDeploymentInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerDeploymentInfo & $Properties
Decodes a WorkerDeploymentInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerDeploymentInfo & $Properties
WorkerDeploymentInfo
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 WorkerDeploymentInfo message. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerDeploymentInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerDeploymentInfo message, length delimited. Does not implicitly temporal.api.deployment.v1.WorkerDeploymentInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerDeploymentInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerDeploymentInfo
Creates a WorkerDeploymentInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerDeploymentInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkerDeploymentInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerDeploymentInfo | WorkerDeploymentInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object