Class: DescribeTaskQueueRequest

workflowservice.v1.DescribeTaskQueueRequest

(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)

Implements

• IDescribeTaskQueueRequest

Constructors

constructor

• new DescribeTaskQueueRequest(properties?): DescribeTaskQueueRequest

Constructs a new DescribeTaskQueueRequest.

Parameters

Name	Type	Description
properties?	IDescribeTaskQueueRequest	Properties to set

Returns

DescribeTaskQueueRequest

Properties

apiMode

• apiMode: DescribeTaskQueueMode

Deprecated. ENHANCED mode is also being deprecated. Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode. Consult the documentation for each field to understand which mode it is supported in.

Implementation of

IDescribeTaskQueueRequest.apiMode

---

includeTaskQueueStatus

• includeTaskQueueStatus: boolean

Deprecated, use report_stats instead. If true, the task queue status will be included in the response.

Implementation of

IDescribeTaskQueueRequest.includeTaskQueueStatus

---

namespace

• namespace: string

DescribeTaskQueueRequest namespace.

Implementation of

IDescribeTaskQueueRequest.namespace

---

reportConfig

• reportConfig: boolean

Report Task Queue Config

Implementation of

IDescribeTaskQueueRequest.reportConfig

---

reportPollers

• reportPollers: boolean

Deprecated (as part of the ENHANCED mode deprecation). Report list of pollers for requested task queue types and versions.

Implementation of

IDescribeTaskQueueRequest.reportPollers

---

reportStats

• reportStats: boolean

Report stats for the requested task queue type(s).

Implementation of

IDescribeTaskQueueRequest.reportStats

---

reportTaskReachability

• reportTaskReachability: boolean

Deprecated (as part of the ENHANCED mode deprecation). Report task reachability for the requested versions and all task types (task reachability is not reported per task type).

Implementation of

IDescribeTaskQueueRequest.reportTaskReachability

---

taskQueue

• Optional taskQueue: null | ITaskQueue

Sticky queues are not supported in deprecated ENHANCED mode.

Implementation of

IDescribeTaskQueueRequest.taskQueue

---

taskQueueType

• taskQueueType: TaskQueueType

If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used. Only supported in default mode (use task_queue_types in ENHANCED mode instead).

Implementation of

IDescribeTaskQueueRequest.taskQueueType

---

taskQueueTypes

• taskQueueTypes: TaskQueueType[]

Deprecated (as part of the ENHANCED mode deprecation). Task queue types to report info about. If not specified, all types are considered.

Implementation of

IDescribeTaskQueueRequest.taskQueueTypes

---

versions

• Optional versions: null | ITaskQueueVersionSelection

Deprecated (as part of the ENHANCED mode deprecation). Optional. If not provided, the result for the default Build ID will be returned. The default Build ID is the one mentioned in the first unconditional Assignment Rule. If there is no default Build ID, the result for the unversioned queue will be returned. (-- api-linter: core::0140::prepositions --)

Implementation of

IDescribeTaskQueueRequest.versions

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

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

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

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

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