Skip to main content

Class: GetWorkerTaskReachabilityRequest

[cleanup-wv-pre-release] Deprecated. Use DescribeTaskQueue.

Properties​

buildIds​

buildIds: string[]

Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker. The number of build ids that can be queried in a single API call is limited. Open source users can adjust this limit by setting the server's dynamic config value for limit.reachabilityQueryBuildIds with the caveat that this call can strain the visibility store.

namespace​

namespace: string

GetWorkerTaskReachabilityRequest namespace.

reachability​

reachability: TaskReachability

Type of reachability to query for. TASK_REACHABILITY_NEW_WORKFLOWS is always returned in the response. Use TASK_REACHABILITY_EXISTING_WORKFLOWS if your application needs to respond to queries on closed workflows. Otherwise, use TASK_REACHABILITY_OPEN_WORKFLOWS. Default is TASK_REACHABILITY_EXISTING_WORKFLOWS if left unspecified. See the TaskReachability docstring for information about each enum variant.

taskQueues​

taskQueues: string[]

Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given build ids in the namespace. Must specify at least one task queue if querying for an unversioned worker. The number of task queues that the server will fetch reachability information for is limited. See the GetWorkerTaskReachabilityResponse documentation for more information.

Methods​

toJSON()​

toJSON(): object

Converts this GetWorkerTaskReachabilityRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GetWorkerTaskReachabilityRequest & $Properties

Creates a new GetWorkerTaskReachabilityRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetWorkerTaskReachabilityRequest & $Properties

GetWorkerTaskReachabilityRequest instance

Call Signature​

static create(properties?): GetWorkerTaskReachabilityRequest

Creates a new GetWorkerTaskReachabilityRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetWorkerTaskReachabilityRequest

GetWorkerTaskReachabilityRequest instance

decode()​

static decode(reader, length?): GetWorkerTaskReachabilityRequest & $Properties

Decodes a GetWorkerTaskReachabilityRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

GetWorkerTaskReachabilityRequest & $Properties

GetWorkerTaskReachabilityRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GetWorkerTaskReachabilityRequest & $Properties

Decodes a GetWorkerTaskReachabilityRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GetWorkerTaskReachabilityRequest & $Properties

GetWorkerTaskReachabilityRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified GetWorkerTaskReachabilityRequest message. Does not implicitly temporal.api.workflowservice.v1.GetWorkerTaskReachabilityRequest.verify|verify messages.

Parameters​

message​

$Properties

GetWorkerTaskReachabilityRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified GetWorkerTaskReachabilityRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetWorkerTaskReachabilityRequest.verify|verify messages.

Parameters​

message​

$Properties

GetWorkerTaskReachabilityRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GetWorkerTaskReachabilityRequest

Creates a GetWorkerTaskReachabilityRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GetWorkerTaskReachabilityRequest

GetWorkerTaskReachabilityRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a GetWorkerTaskReachabilityRequest message. Also converts values to other types if specified.

Parameters​

message​

GetWorkerTaskReachabilityRequest

GetWorkerTaskReachabilityRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object