Skip to main content

Class: DescribeDeploymentRequest

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

Properties​

deployment?​

optional deployment?: $Properties | null

DescribeDeploymentRequest deployment.

namespace​

namespace: string

DescribeDeploymentRequest namespace.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeDeploymentRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeDeploymentRequest & $Properties

Creates a new DescribeDeploymentRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeDeploymentRequest & $Properties

DescribeDeploymentRequest instance

Call Signature​

static create(properties?): DescribeDeploymentRequest

Creates a new DescribeDeploymentRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeDeploymentRequest

DescribeDeploymentRequest instance

decode()​

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

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

DescribeDeploymentRequest & $Properties

DescribeDeploymentRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeDeploymentRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeDeploymentRequest & $Properties

DescribeDeploymentRequest

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

Parameters​

message​

$Properties

DescribeDeploymentRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeDeploymentRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeDeploymentRequest

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

Parameters​

object​

Plain object

Returns​

DescribeDeploymentRequest

DescribeDeploymentRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeDeploymentRequest

DescribeDeploymentRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object