Skip to main content

Class: DeleteWorkerDeploymentRequest

Deletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it.

Properties​

deploymentName​

deploymentName: string

DeleteWorkerDeploymentRequest deploymentName.

identity​

identity: string

Optional. The identity of the client who initiated this request.

namespace​

namespace: string

DeleteWorkerDeploymentRequest namespace.

Methods​

toJSON()​

toJSON(): object

Converts this DeleteWorkerDeploymentRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeleteWorkerDeploymentRequest & $Properties

Creates a new DeleteWorkerDeploymentRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteWorkerDeploymentRequest & $Properties

DeleteWorkerDeploymentRequest instance

Call Signature​

static create(properties?): DeleteWorkerDeploymentRequest

Creates a new DeleteWorkerDeploymentRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteWorkerDeploymentRequest

DeleteWorkerDeploymentRequest instance

decode()​

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

Decodes a DeleteWorkerDeploymentRequest 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​

DeleteWorkerDeploymentRequest & $Properties

DeleteWorkerDeploymentRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeleteWorkerDeploymentRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeleteWorkerDeploymentRequest & $Properties

DeleteWorkerDeploymentRequest

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 DeleteWorkerDeploymentRequest message. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkerDeploymentRequest.verify|verify messages.

Parameters​

message​

$Properties

DeleteWorkerDeploymentRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeleteWorkerDeploymentRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeleteWorkerDeploymentRequest

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

Parameters​

object​

Plain object

Returns​

DeleteWorkerDeploymentRequest

DeleteWorkerDeploymentRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeleteWorkerDeploymentRequest

DeleteWorkerDeploymentRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object