Skip to main content

Class: CreateWorkerDeploymentVersionRequest

Creates a new WorkerDeploymentVersion.

Properties​

computeConfig?​

optional computeConfig?: $Properties | null

Optional. Contains the new worker compute configuration for the Worker Deployment. Used for worker scale management.


deploymentVersion?​

optional deploymentVersion?: $Properties | null

Required.


identity​

identity: string

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


namespace​

namespace: string

CreateWorkerDeploymentVersionRequest namespace.


requestId​

requestId: string

A unique identifier for this create request for idempotence. Typically UUIDv4. If a second request with the same ID is recieved, it is considered a successful no-op. Retrying with a different request ID for the same deployment name + build ID is an error.

Methods​

toJSON()​

toJSON(): object

Converts this CreateWorkerDeploymentVersionRequest to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): CreateWorkerDeploymentVersionRequest & $Properties

Creates a new CreateWorkerDeploymentVersionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateWorkerDeploymentVersionRequest & $Properties

CreateWorkerDeploymentVersionRequest instance

Call Signature​

static create(properties?): CreateWorkerDeploymentVersionRequest

Creates a new CreateWorkerDeploymentVersionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CreateWorkerDeploymentVersionRequest

CreateWorkerDeploymentVersionRequest instance


decode()​

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

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

CreateWorkerDeploymentVersionRequest & $Properties

CreateWorkerDeploymentVersionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): CreateWorkerDeploymentVersionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CreateWorkerDeploymentVersionRequest & $Properties

CreateWorkerDeploymentVersionRequest

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

Parameters​

message​

$Properties

CreateWorkerDeploymentVersionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CreateWorkerDeploymentVersionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): CreateWorkerDeploymentVersionRequest

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

Parameters​

object​

Plain object

Returns​

CreateWorkerDeploymentVersionRequest

CreateWorkerDeploymentVersionRequest


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CreateWorkerDeploymentVersionRequest

CreateWorkerDeploymentVersionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object