Class: DescribeTaskQueueResponse
workflowservice.v1.DescribeTaskQueueResponse
Represents a DescribeTaskQueueResponse.
Properties
config
• Optional config: null | $Properties
Only populated if report_task_queue_config is set to true.
effectiveRateLimit
• Optional effectiveRateLimit: null | $Properties
DescribeTaskQueueResponse effectiveRateLimit.
pollers
• pollers: $Properties[]
DescribeTaskQueueResponse pollers.
stats
• Optional stats: null | $Properties
Statistics for the task queue.
Only set if report_stats is set on the request.
statsByPriorityKey
• statsByPriorityKey: Object
Task queue stats breakdown by priority key. Only contains actively used priority keys.
Only set if report_stats is set on the request.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: "by" is used to clarify the keys and values. --)
Index signature
▪ [k: string]: $Properties
taskQueueStatus
• Optional taskQueueStatus: null | $Properties
Deprecated.
Status of the task queue. Only populated when include_task_queue_status is set to true in the request.
versioningInfo
• Optional versioningInfo: null | $Properties
Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to. When not present, it means the tasks are routed to Unversioned workers (workers with UNVERSIONED or unspecified WorkerVersioningMode.) Task Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion and SetWorkerDeploymentRampingVersion on Worker Deployments. Note: This information is not relevant to Pinned workflow executions and their activities as they are always routed to their Pinned Deployment Version. However, new workflow executions are typically not Pinned until they complete their first task (unless they are started with a Pinned VersioningOverride or are Child Workflows of a Pinned parent).
versionsInfo
• versionsInfo: Object
Deprecated. Only returned in ENHANCED mode. This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.
Index signature
▪ [k: string]: $Properties
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeTaskQueueResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeTaskQueueResponse & $Properties
Creates a new DescribeTaskQueueResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DescribeTaskQueueResponse & $Properties
DescribeTaskQueueResponse instance
▸ create(properties?): DescribeTaskQueueResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DescribeTaskQueueResponse & $Properties
Decodes a DescribeTaskQueueResponse 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
DescribeTaskQueueResponse & $Properties
DescribeTaskQueueResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeTaskQueueResponse & $Properties
Decodes a DescribeTaskQueueResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeTaskQueueResponse & $Properties
DescribeTaskQueueResponse
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 DescribeTaskQueueResponse message. Does not implicitly temporal.api.workflowservice.v1.DescribeTaskQueueResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeTaskQueueResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeTaskQueueResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeTaskQueueResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeTaskQueueResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeTaskQueueResponse
Creates a DescribeTaskQueueResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeTaskQueueResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeTaskQueueResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeTaskQueueResponse | DescribeTaskQueueResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object