Skip to main content

Class: GetWorkerTaskReachabilityResponse

workflowservice.v1.GetWorkerTaskReachabilityResponse

Deprecated. Use DescribeTaskQueue.

Implements

Constructors

constructor

new GetWorkerTaskReachabilityResponse(properties?): GetWorkerTaskReachabilityResponse

Constructs a new GetWorkerTaskReachabilityResponse.

Parameters

NameTypeDescription
properties?IGetWorkerTaskReachabilityResponseProperties to set

Returns

GetWorkerTaskReachabilityResponse

Properties

buildIdReachability

buildIdReachability: IBuildIdReachability[]

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.

Implementation of

IGetWorkerTaskReachabilityResponse.buildIdReachability

Methods

toJSON

toJSON(): Object

Converts this GetWorkerTaskReachabilityResponse to JSON.

Returns

Object

JSON object


create

create(properties?): GetWorkerTaskReachabilityResponse

Creates a new GetWorkerTaskReachabilityResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IGetWorkerTaskReachabilityResponseProperties to set

Returns

GetWorkerTaskReachabilityResponse

GetWorkerTaskReachabilityResponse instance


decode

decode(reader, length?): GetWorkerTaskReachabilityResponse

Decodes a GetWorkerTaskReachabilityResponse message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

GetWorkerTaskReachabilityResponse

GetWorkerTaskReachabilityResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): GetWorkerTaskReachabilityResponse

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

GetWorkerTaskReachabilityResponse

GetWorkerTaskReachabilityResponse

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 GetWorkerTaskReachabilityResponse message. Does not implicitly temporal.api.workflowservice.v1.GetWorkerTaskReachabilityResponse.verify|verify messages.

Parameters

NameTypeDescription
messageIGetWorkerTaskReachabilityResponseGetWorkerTaskReachabilityResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIGetWorkerTaskReachabilityResponseGetWorkerTaskReachabilityResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): GetWorkerTaskReachabilityResponse

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

GetWorkerTaskReachabilityResponse

GetWorkerTaskReachabilityResponse


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetWorkerTaskReachabilityResponse

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageGetWorkerTaskReachabilityResponseGetWorkerTaskReachabilityResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object