Skip to main content

Class: DescribeDeploymentRequest

workflowservice.v1.DescribeDeploymentRequest

Represents a DescribeDeploymentRequest.

Implements

Constructors

constructor

new DescribeDeploymentRequest(properties?): DescribeDeploymentRequest

Constructs a new DescribeDeploymentRequest.

Parameters

NameTypeDescription
properties?IDescribeDeploymentRequestProperties to set

Returns

DescribeDeploymentRequest

Properties

deployment

Optional deployment: null | IDeployment

DescribeDeploymentRequest deployment.

Implementation of

IDescribeDeploymentRequest.deployment


namespace

namespace: string

DescribeDeploymentRequest namespace.

Implementation of

IDescribeDeploymentRequest.namespace

Methods

toJSON

toJSON(): Object

Converts this DescribeDeploymentRequest to JSON.

Returns

Object

JSON object


create

create(properties?): DescribeDeploymentRequest

Creates a new DescribeDeploymentRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IDescribeDeploymentRequestProperties to set

Returns

DescribeDeploymentRequest

DescribeDeploymentRequest instance


decode

decode(reader, length?): DescribeDeploymentRequest

Decodes a DescribeDeploymentRequest message from the specified reader or buffer.

Parameters

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

Returns

DescribeDeploymentRequest

DescribeDeploymentRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): DescribeDeploymentRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

DescribeDeploymentRequest

DescribeDeploymentRequest

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): DescribeDeploymentRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

DescribeDeploymentRequest

DescribeDeploymentRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for DescribeDeploymentRequest

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 DescribeDeploymentRequest message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageDescribeDeploymentRequestDescribeDeploymentRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object