Class: DeleteWorkerDeploymentVersionRequest
workflowservice.v1.DeleteWorkerDeploymentVersionRequest
Used for manual deletion of Versions. User can delete a Version only when all the following conditions are met:
- It is not the Current or Ramping Version of its Deployment.
- It has no active pollers (none of the task queues in the Version have pollers)
- It is not draining (see WorkerDeploymentVersionInfo.drainage_info). This condition
can be skipped by passing
skip-drainage=true.
Properties
deploymentVersion
• Optional deploymentVersion: null | $Properties
Required.
identity
• identity: string
Optional. The identity of the client who initiated this request.
namespace
• namespace: string
DeleteWorkerDeploymentVersionRequest namespace.
skipDrainage
• skipDrainage: boolean
Pass to force deletion even if the Version is draining. In this case the open pinned workflows will be stuck until manually moved to another version by UpdateWorkflowExecutionOptions.
version
• version: string
Deprecated. Use deployment_version.
Methods
toJSON
▸ toJSON(): Object
Converts this DeleteWorkerDeploymentVersionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeleteWorkerDeploymentVersionRequest & $Properties
Creates a new DeleteWorkerDeploymentVersionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DeleteWorkerDeploymentVersionRequest & $Properties
DeleteWorkerDeploymentVersionRequest instance
▸ create(properties?): DeleteWorkerDeploymentVersionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
DeleteWorkerDeploymentVersionRequest
decode
▸ decode(reader, length?): DeleteWorkerDeploymentVersionRequest & $Properties
Decodes a DeleteWorkerDeploymentVersionRequest 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
DeleteWorkerDeploymentVersionRequest & $Properties
DeleteWorkerDeploymentVersionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeleteWorkerDeploymentVersionRequest & $Properties
Decodes a DeleteWorkerDeploymentVersionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeleteWorkerDeploymentVersionRequest & $Properties
DeleteWorkerDeploymentVersionRequest
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 DeleteWorkerDeploymentVersionRequest message. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkerDeploymentVersionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeleteWorkerDeploymentVersionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeleteWorkerDeploymentVersionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkerDeploymentVersionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeleteWorkerDeploymentVersionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeleteWorkerDeploymentVersionRequest
Creates a DeleteWorkerDeploymentVersionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeleteWorkerDeploymentVersionRequest
DeleteWorkerDeploymentVersionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DeleteWorkerDeploymentVersionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeleteWorkerDeploymentVersionRequest | DeleteWorkerDeploymentVersionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object