Skip to main content

Class: BuildIdReachability

Reachability of tasks for a worker by build id, in one or more task queues.

Properties​

buildId​

buildId: string

A build id or empty if unversioned.

taskQueueReachability​

taskQueueReachability: $Properties[]

Reachability per task queue.

Methods​

toJSON()​

toJSON(): object

Converts this BuildIdReachability to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BuildIdReachability & $Properties

Creates a new BuildIdReachability instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BuildIdReachability & $Properties

BuildIdReachability instance

Call Signature​

static create(properties?): BuildIdReachability

Creates a new BuildIdReachability instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BuildIdReachability

BuildIdReachability instance

decode()​

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

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

BuildIdReachability & $Properties

BuildIdReachability

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BuildIdReachability & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BuildIdReachability & $Properties

BuildIdReachability

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

Parameters​

message​

$Properties

BuildIdReachability message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BuildIdReachability message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BuildIdReachability

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

Parameters​

object​

Plain object

Returns​

BuildIdReachability

BuildIdReachability

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BuildIdReachability

BuildIdReachability

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object