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.
Implements
Constructors
constructor
• new DeleteWorkerDeploymentVersionRequest(properties?): DeleteWorkerDeploymentVersionRequest
Constructs a new DeleteWorkerDeploymentVersionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteWorkerDeploymentVersionRequest | Properties to set |
Returns
DeleteWorkerDeploymentVersionRequest
Properties
identity
• identity: string
Optional. The identity of the client who initiated this request.
Implementation of
IDeleteWorkerDeploymentVersionRequest.identity
namespace
• namespace: string
DeleteWorkerDeploymentVersionRequest namespace.
Implementation of
IDeleteWorkerDeploymentVersionRequest.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.
Implementation of
IDeleteWorkerDeploymentVersionRequest.skipDrainage
version
• version: string
Deployment Version identifier in the form "<deployment_name>.<build_id>".
Implementation of
IDeleteWorkerDeploymentVersionRequest.version
Methods
toJSON
▸ toJSON(): Object
Converts this DeleteWorkerDeploymentVersionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeleteWorkerDeploymentVersionRequest
Creates a new DeleteWorkerDeploymentVersionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteWorkerDeploymentVersionRequest | Properties to set |
Returns
DeleteWorkerDeploymentVersionRequest
DeleteWorkerDeploymentVersionRequest instance
decode
▸ decode(reader, length?): DeleteWorkerDeploymentVersionRequest
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
DeleteWorkerDeploymentVersionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeleteWorkerDeploymentVersionRequest
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
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 | IDeleteWorkerDeploymentVersionRequest | 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 | IDeleteWorkerDeploymentVersionRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DeleteWorkerDeploymentVersionRequest
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 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