Skip to main content

Class: DescribeWorkerDeploymentResponse

Represents a DescribeWorkerDeploymentResponse.

Properties​

conflictToken​

conflictToken: Uint8Array

This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this read and a future write.


workerDeploymentInfo?​

optional workerDeploymentInfo?: $Properties | null

DescribeWorkerDeploymentResponse workerDeploymentInfo.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeWorkerDeploymentResponse to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): DescribeWorkerDeploymentResponse & $Properties

Creates a new DescribeWorkerDeploymentResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkerDeploymentResponse & $Properties

DescribeWorkerDeploymentResponse instance

Call Signature​

static create(properties?): DescribeWorkerDeploymentResponse

Creates a new DescribeWorkerDeploymentResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkerDeploymentResponse

DescribeWorkerDeploymentResponse instance


decode()​

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

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

DescribeWorkerDeploymentResponse & $Properties

DescribeWorkerDeploymentResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): DescribeWorkerDeploymentResponse & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeWorkerDeploymentResponse & $Properties

DescribeWorkerDeploymentResponse

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

Parameters​

message​

$Properties

DescribeWorkerDeploymentResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeWorkerDeploymentResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): DescribeWorkerDeploymentResponse

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

Parameters​

object​

Plain object

Returns​

DescribeWorkerDeploymentResponse

DescribeWorkerDeploymentResponse


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeWorkerDeploymentResponse

DescribeWorkerDeploymentResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object