Class: DescribeDeploymentResponse
workflowservice.v1.DescribeDeploymentResponse
Represents a DescribeDeploymentResponse.
Implements
Constructors
constructor
• new DescribeDeploymentResponse(properties?): DescribeDeploymentResponse
Constructs a new DescribeDeploymentResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeDeploymentResponse | Properties to set |
Returns
Properties
deploymentInfo
• Optional deploymentInfo: null | IDeploymentInfo
DescribeDeploymentResponse deploymentInfo.
Implementation of
IDescribeDeploymentResponse.deploymentInfo
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeDeploymentResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeDeploymentResponse
Creates a new DescribeDeploymentResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeDeploymentResponse | Properties to set |
Returns
DescribeDeploymentResponse instance
decode
▸ decode(reader, length?): DescribeDeploymentResponse
Decodes a DescribeDeploymentResponse message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
DescribeDeploymentResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeDeploymentResponse
Decodes a DescribeDeploymentResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IDescribeDeploymentResponse | DescribeDeploymentResponse message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IDescribeDeploymentResponse | DescribeDeploymentResponse message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeDeploymentResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DescribeDeploymentResponse
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeDeploymentResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeDeploymentResponse | DescribeDeploymentResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object