Skip to main content

Class: ListWorkersResponse

Represents a ListWorkersResponse.

Properties​

nextPageToken​

nextPageToken: Uint8Array

Next page token


workers​

workers: $Properties[]

Limited worker information.


workersInfo​

workersInfo: $Properties[]

Deprecated: Use workers instead. This field returns full WorkerInfo which includes expensive runtime metrics. We will stop populating this field in the future.

Methods​

toJSON()​

toJSON(): object

Converts this ListWorkersResponse to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): ListWorkersResponse & $Shape

Creates a new ListWorkersResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ListWorkersResponse & $Shape

ListWorkersResponse instance

Call Signature​

static create(properties?): ListWorkersResponse

Creates a new ListWorkersResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListWorkersResponse

ListWorkersResponse instance


decode()​

static decode(reader, length?): ListWorkersResponse & $Shape

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

ListWorkersResponse & $Shape

ListWorkersResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): ListWorkersResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ListWorkersResponse & $Shape

ListWorkersResponse

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

Parameters​

message​

$Properties

ListWorkersResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ListWorkersResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): ListWorkersResponse

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

Parameters​

object​

Plain object

Returns​

ListWorkersResponse

ListWorkersResponse


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ListWorkersResponse

ListWorkersResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object