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