Class: GetWorkerTaskReachabilityResponse
[cleanup-wv-pre-release]
Deprecated. Use DescribeTaskQueue.
Properties
buildIdReachability
buildIdReachability:
$Properties[]
Task reachability, broken down by build id and then task queue. When requesting a large number of task queues or all task queues associated with the given build ids in a namespace, all task queues will be listed in the response but some of them may not contain reachability information due to a server enforced limit. When reaching the limit, task queues that reachability information could not be retrieved for will be marked with a single TASK_REACHABILITY_UNSPECIFIED entry. The caller may issue another call to get the reachability for those task queues.
Open source users can adjust this limit by setting the server's dynamic config value for
limit.reachabilityTaskQueueScan with the caveat that this call can strain the visibility store.
Methods
toJSON()
toJSON():
object
Converts this GetWorkerTaskReachabilityResponse to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):GetWorkerTaskReachabilityResponse&$Properties
Creates a new GetWorkerTaskReachabilityResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
GetWorkerTaskReachabilityResponse & $Properties
GetWorkerTaskReachabilityResponse instance
Call Signature
staticcreate(properties?):GetWorkerTaskReachabilityResponse
Creates a new GetWorkerTaskReachabilityResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
GetWorkerTaskReachabilityResponse
GetWorkerTaskReachabilityResponse instance
decode()
staticdecode(reader,length?):GetWorkerTaskReachabilityResponse&$Properties
Decodes a GetWorkerTaskReachabilityResponse 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
GetWorkerTaskReachabilityResponse & $Properties
GetWorkerTaskReachabilityResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):GetWorkerTaskReachabilityResponse&$Properties
Decodes a GetWorkerTaskReachabilityResponse message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
GetWorkerTaskReachabilityResponse & $Properties
GetWorkerTaskReachabilityResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified GetWorkerTaskReachabilityResponse message. Does not implicitly temporal.api.workflowservice.v1.GetWorkerTaskReachabilityResponse.verify|verify messages.
Parameters
message
GetWorkerTaskReachabilityResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified GetWorkerTaskReachabilityResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetWorkerTaskReachabilityResponse.verify|verify messages.
Parameters
message
GetWorkerTaskReachabilityResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):GetWorkerTaskReachabilityResponse
Creates a GetWorkerTaskReachabilityResponse message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
GetWorkerTaskReachabilityResponse
GetWorkerTaskReachabilityResponse
toObject()
statictoObject(message,options?):object
Creates a plain object from a GetWorkerTaskReachabilityResponse message. Also converts values to other types if specified.
Parameters
message
GetWorkerTaskReachabilityResponse
GetWorkerTaskReachabilityResponse
options?
IConversionOptions
Conversion options
Returns
object
Plain object