Skip to main content

Class: DescribeWorkerDeploymentVersionRequest

workflowservice.v1.DescribeWorkerDeploymentVersionRequest

Represents a DescribeWorkerDeploymentVersionRequest.

Implements

Constructors

constructor

new DescribeWorkerDeploymentVersionRequest(properties?): DescribeWorkerDeploymentVersionRequest

Constructs a new DescribeWorkerDeploymentVersionRequest.

Parameters

NameTypeDescription
properties?IDescribeWorkerDeploymentVersionRequestProperties to set

Returns

DescribeWorkerDeploymentVersionRequest

Properties

namespace

namespace: string

DescribeWorkerDeploymentVersionRequest namespace.

Implementation of

IDescribeWorkerDeploymentVersionRequest.namespace


version

version: string

Deployment Version identifier in the form "<deployment_name>.<build_id>".

Implementation of

IDescribeWorkerDeploymentVersionRequest.version

Methods

toJSON

toJSON(): Object

Converts this DescribeWorkerDeploymentVersionRequest to JSON.

Returns

Object

JSON object


create

create(properties?): DescribeWorkerDeploymentVersionRequest

Creates a new DescribeWorkerDeploymentVersionRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeWorkerDeploymentVersionRequestProperties to set

Returns

DescribeWorkerDeploymentVersionRequest

DescribeWorkerDeploymentVersionRequest instance


decode

decode(reader, length?): DescribeWorkerDeploymentVersionRequest

Decodes a DescribeWorkerDeploymentVersionRequest message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

DescribeWorkerDeploymentVersionRequest

DescribeWorkerDeploymentVersionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): DescribeWorkerDeploymentVersionRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

DescribeWorkerDeploymentVersionRequest

DescribeWorkerDeploymentVersionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIDescribeWorkerDeploymentVersionRequestDescribeWorkerDeploymentVersionRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIDescribeWorkerDeploymentVersionRequestDescribeWorkerDeploymentVersionRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): DescribeWorkerDeploymentVersionRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

DescribeWorkerDeploymentVersionRequest

DescribeWorkerDeploymentVersionRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeWorkerDeploymentVersionRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageDescribeWorkerDeploymentVersionRequestDescribeWorkerDeploymentVersionRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object