Skip to main content

Class: TaskQueueReachability

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

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.

taskQueue​

taskQueue: string

TaskQueueReachability taskQueue.

Methods​

toJSON()​

toJSON(): object

Converts this TaskQueueReachability to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TaskQueueReachability & $Properties

Creates a new TaskQueueReachability instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueReachability & $Properties

TaskQueueReachability instance

Call Signature​

static create(properties?): TaskQueueReachability

Creates a new TaskQueueReachability instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueReachability

TaskQueueReachability instance

decode()​

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

Decodes a TaskQueueReachability 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​

TaskQueueReachability & $Properties

TaskQueueReachability

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TaskQueueReachability & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TaskQueueReachability & $Properties

TaskQueueReachability

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

Parameters​

message​

$Properties

TaskQueueReachability message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TaskQueueReachability message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TaskQueueReachability

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

TaskQueueReachability

TaskQueueReachability

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TaskQueueReachability

TaskQueueReachability

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object