Skip to main content

Class: CreateWorkerDeploymentRequest

Creates a new WorkerDeployment.

Properties​

deploymentName​

deploymentName: string

The name of the Worker Deployment to create. If a Worker Deployment with this name already exists, an error will be returned.

identity​

identity: string

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

namespace​

namespace: string

CreateWorkerDeploymentRequest namespace.

requestId​

requestId: string

A unique identifier for this create request for idempotence. Typically UUIDv4.

Methods​

toJSON()​

toJSON(): object

Converts this CreateWorkerDeploymentRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CreateWorkerDeploymentRequest & $Properties

Creates a new CreateWorkerDeploymentRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateWorkerDeploymentRequest & $Properties

CreateWorkerDeploymentRequest instance

Call Signature​

static create(properties?): CreateWorkerDeploymentRequest

Creates a new CreateWorkerDeploymentRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateWorkerDeploymentRequest

CreateWorkerDeploymentRequest instance

decode()​

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

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

CreateWorkerDeploymentRequest & $Properties

CreateWorkerDeploymentRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CreateWorkerDeploymentRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CreateWorkerDeploymentRequest & $Properties

CreateWorkerDeploymentRequest

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

Parameters​

message​

$Properties

CreateWorkerDeploymentRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CreateWorkerDeploymentRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CreateWorkerDeploymentRequest

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

Parameters​

object​

Plain object

Returns​

CreateWorkerDeploymentRequest

CreateWorkerDeploymentRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CreateWorkerDeploymentRequest

CreateWorkerDeploymentRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object