Skip to main content

Class: TaskQueueReachability

taskqueue.v1.TaskQueueReachability

Reachability of tasks for a worker on a single task queue.

Implements

Constructors

constructor

new TaskQueueReachability(properties?): TaskQueueReachability

Constructs a new TaskQueueReachability.

Parameters

NameTypeDescription
properties?ITaskQueueReachabilityProperties to set

Returns

TaskQueueReachability

Properties

reachability

reachability: TaskReachability[]

Task reachability for a worker in a single task queue. See the TaskReachability docstring for information about each enum variant. If reachability is empty, this worker is considered unreachable in this task queue.

Implementation of

ITaskQueueReachability.reachability


taskQueue

taskQueue: string

TaskQueueReachability taskQueue.

Implementation of

ITaskQueueReachability.taskQueue

Methods

toJSON

toJSON(): Object

Converts this TaskQueueReachability to JSON.

Returns

Object

JSON object


create

create(properties?): TaskQueueReachability

Creates a new TaskQueueReachability instance using the specified properties.

Parameters

NameTypeDescription
properties?ITaskQueueReachabilityProperties to set

Returns

TaskQueueReachability

TaskQueueReachability instance


decode

decode(reader, length?): TaskQueueReachability

Decodes a TaskQueueReachability message from the specified reader or buffer.

Parameters

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

Returns

TaskQueueReachability

TaskQueueReachability

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): TaskQueueReachability

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

TaskQueueReachability

TaskQueueReachability

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): TaskQueueReachability

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

TaskQueueReachability

TaskQueueReachability


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TaskQueueReachability

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 TaskQueueReachability message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageTaskQueueReachabilityTaskQueueReachability
options?IConversionOptionsConversion options

Returns

Object

Plain object