Skip to main content

Class: ListWorkersRequest

Represents a ListWorkersRequest.

Properties​

includeSystemWorkers​

includeSystemWorkers: boolean

When true, the response will include system workers that are created implicitly by the server and not by the user. By default, system workers are excluded.

namespace​

namespace: string

ListWorkersRequest namespace.

nextPageToken​

nextPageToken: Uint8Array

ListWorkersRequest nextPageToken.

pageSize​

pageSize: number

ListWorkersRequest pageSize.

query​

query: string

query in ListWorkers is used to filter workers based on worker attributes. Supported attributes:

  • WorkerInstanceKey
  • WorkerIdentity
  • HostName
  • TaskQueue
  • DeploymentName
  • BuildId
  • SdkName
  • SdkVersion
  • StartTime
  • Status

Methods​

toJSON()​

toJSON(): object

Converts this ListWorkersRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ListWorkersRequest & $Properties

Creates a new ListWorkersRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListWorkersRequest & $Properties

ListWorkersRequest instance

Call Signature​

static create(properties?): ListWorkersRequest

Creates a new ListWorkersRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ListWorkersRequest

ListWorkersRequest instance

decode()​

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

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

ListWorkersRequest & $Properties

ListWorkersRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ListWorkersRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ListWorkersRequest & $Properties

ListWorkersRequest

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

Parameters​

message​

$Properties

ListWorkersRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ListWorkersRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ListWorkersRequest

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

Parameters​

object​

Plain object

Returns​

ListWorkersRequest

ListWorkersRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ListWorkersRequest

ListWorkersRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object