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