Skip to main content

Class: DescribeDeploymentResponse

workflowservice.v1.DescribeDeploymentResponse

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

Properties​

deploymentInfo​

• Optional deploymentInfo: null | $Properties

DescribeDeploymentResponse deploymentInfo.

Methods​

toJSON​

▸ toJSON(): Object

Converts this DescribeDeploymentResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): DescribeDeploymentResponse & $Properties

Creates a new DescribeDeploymentResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

DescribeDeploymentResponse & $Properties

DescribeDeploymentResponse instance

▸ create(properties?): DescribeDeploymentResponse

Parameters​

NameType
properties?$Properties

Returns​

DescribeDeploymentResponse


decode​

▸ decode(reader, length?): DescribeDeploymentResponse & $Properties

Decodes a DescribeDeploymentResponse message from the specified reader or buffer.

Parameters​

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

Returns​

DescribeDeploymentResponse & $Properties

DescribeDeploymentResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): DescribeDeploymentResponse & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

DescribeDeploymentResponse & $Properties

DescribeDeploymentResponse

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

Parameters​

NameTypeDescription
message$PropertiesDescribeDeploymentResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesDescribeDeploymentResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): DescribeDeploymentResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

DescribeDeploymentResponse

DescribeDeploymentResponse


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageDescribeDeploymentResponseDescribeDeploymentResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object