Skip to main content

Class: DescribeWorkerDeploymentVersionRequest

Represents a DescribeWorkerDeploymentVersionRequest.

Properties​

deploymentVersion?​

optional deploymentVersion?: $Properties | null

Required.


namespace​

namespace: string

DescribeWorkerDeploymentVersionRequest namespace.


reportTaskQueueStats​

reportTaskQueueStats: boolean

Report stats for task queues which have been polled by this version.


version​

version: string

Deprecated. Use deployment_version.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeWorkerDeploymentVersionRequest to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): DescribeWorkerDeploymentVersionRequest & $Properties

Creates a new DescribeWorkerDeploymentVersionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkerDeploymentVersionRequest & $Properties

DescribeWorkerDeploymentVersionRequest instance

Call Signature​

static create(properties?): DescribeWorkerDeploymentVersionRequest

Creates a new DescribeWorkerDeploymentVersionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeWorkerDeploymentVersionRequest

DescribeWorkerDeploymentVersionRequest instance


decode()​

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

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

DescribeWorkerDeploymentVersionRequest & $Properties

DescribeWorkerDeploymentVersionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): DescribeWorkerDeploymentVersionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeWorkerDeploymentVersionRequest & $Properties

DescribeWorkerDeploymentVersionRequest

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

Parameters​

message​

$Properties

DescribeWorkerDeploymentVersionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeWorkerDeploymentVersionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): DescribeWorkerDeploymentVersionRequest

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

Parameters​

object​

Plain object

Returns​

DescribeWorkerDeploymentVersionRequest

DescribeWorkerDeploymentVersionRequest


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeWorkerDeploymentVersionRequest

DescribeWorkerDeploymentVersionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object