Class: DescribeWorkerDeploymentRequest
workflowservice.v1.DescribeWorkerDeploymentRequest
Represents a DescribeWorkerDeploymentRequest.
Implements
Constructors
constructor
• new DescribeWorkerDeploymentRequest(properties?): DescribeWorkerDeploymentRequest
Constructs a new DescribeWorkerDeploymentRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeWorkerDeploymentRequest | Properties to set |
Returns
DescribeWorkerDeploymentRequest
Properties
deploymentName
• deploymentName: string
DescribeWorkerDeploymentRequest deploymentName.
Implementation of
IDescribeWorkerDeploymentRequest.deploymentName
namespace
• namespace: string
DescribeWorkerDeploymentRequest namespace.
Implementation of
IDescribeWorkerDeploymentRequest.namespace
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeWorkerDeploymentRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeWorkerDeploymentRequest
Creates a new DescribeWorkerDeploymentRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeWorkerDeploymentRequest | Properties to set |
Returns
DescribeWorkerDeploymentRequest
DescribeWorkerDeploymentRequest instance
decode
▸ decode(reader, length?): DescribeWorkerDeploymentRequest
Decodes a DescribeWorkerDeploymentRequest 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
DescribeWorkerDeploymentRequest
DescribeWorkerDeploymentRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeWorkerDeploymentRequest
Decodes a DescribeWorkerDeploymentRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeWorkerDeploymentRequest
DescribeWorkerDeploymentRequest
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 DescribeWorkerDeploymentRequest message. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDescribeWorkerDeploymentRequest | DescribeWorkerDeploymentRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeWorkerDeploymentRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDescribeWorkerDeploymentRequest | DescribeWorkerDeploymentRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeWorkerDeploymentRequest
Creates a DescribeWorkerDeploymentRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeWorkerDeploymentRequest
DescribeWorkerDeploymentRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DescribeWorkerDeploymentRequest
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 DescribeWorkerDeploymentRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeWorkerDeploymentRequest | DescribeWorkerDeploymentRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object