Class: DescribeWorkerDeploymentVersionRequest
workflowservice.v1.DescribeWorkerDeploymentVersionRequest
Represents a DescribeWorkerDeploymentVersionRequest.
Properties
deploymentVersion
• Optional deploymentVersion: null | $Properties
Required.
namespace
• namespace: string
DescribeWorkerDeploymentVersionRequest namespace.
reportTaskQueueStats
• reportTaskQueueStats: boolean
Report stats for task queues which have been polled by this version.
version
• version: string
Deprecated. Use deployment_version.
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeWorkerDeploymentVersionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeWorkerDeploymentVersionRequest & $Properties
Creates a new DescribeWorkerDeploymentVersionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DescribeWorkerDeploymentVersionRequest & $Properties
DescribeWorkerDeploymentVersionRequest instance
▸ create(properties?): DescribeWorkerDeploymentVersionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
DescribeWorkerDeploymentVersionRequest
decode
▸ decode(reader, length?): DescribeWorkerDeploymentVersionRequest & $Properties
Decodes a DescribeWorkerDeploymentVersionRequest 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
DescribeWorkerDeploymentVersionRequest & $Properties
DescribeWorkerDeploymentVersionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeWorkerDeploymentVersionRequest & $Properties
Decodes a DescribeWorkerDeploymentVersionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeWorkerDeploymentVersionRequest & $Properties
DescribeWorkerDeploymentVersionRequest
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 DescribeWorkerDeploymentVersionRequest message. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentVersionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeWorkerDeploymentVersionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeWorkerDeploymentVersionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentVersionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeWorkerDeploymentVersionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeWorkerDeploymentVersionRequest
Creates a DescribeWorkerDeploymentVersionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeWorkerDeploymentVersionRequest
DescribeWorkerDeploymentVersionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeWorkerDeploymentVersionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeWorkerDeploymentVersionRequest | DescribeWorkerDeploymentVersionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object