Skip to main content

Class: 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?: $Properties | null

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()​

Call Signature​

static create(properties?): DeleteWorkerDeploymentVersionRequest & $Properties

Creates a new DeleteWorkerDeploymentVersionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteWorkerDeploymentVersionRequest & $Properties

DeleteWorkerDeploymentVersionRequest instance

Call Signature​

static create(properties?): DeleteWorkerDeploymentVersionRequest

Creates a new DeleteWorkerDeploymentVersionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteWorkerDeploymentVersionRequest

DeleteWorkerDeploymentVersionRequest instance

decode()​

static decode(reader, length?): DeleteWorkerDeploymentVersionRequest & $Properties

Decodes a DeleteWorkerDeploymentVersionRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): DeleteWorkerDeploymentVersionRequest & $Properties

Decodes a DeleteWorkerDeploymentVersionRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified DeleteWorkerDeploymentVersionRequest message. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkerDeploymentVersionRequest.verify|verify messages.

Parameters​

message​

$Properties

DeleteWorkerDeploymentVersionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified DeleteWorkerDeploymentVersionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkerDeploymentVersionRequest.verify|verify messages.

Parameters​

message​

$Properties

DeleteWorkerDeploymentVersionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeleteWorkerDeploymentVersionRequest

Creates a DeleteWorkerDeploymentVersionRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

DeleteWorkerDeploymentVersionRequest

DeleteWorkerDeploymentVersionRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a DeleteWorkerDeploymentVersionRequest message. Also converts values to other types if specified.

Parameters​

message​

DeleteWorkerDeploymentVersionRequest

DeleteWorkerDeploymentVersionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object