Skip to main content

Class: CountWorkersRequest

Represents a CountWorkersRequest.

Properties​

includeSystemWorkers​

includeSystemWorkers: boolean

When true, the count 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

CountWorkersRequest namespace.

query​

query: string

Query to filter workers before counting. Supported filter fields are the same as in ListWorkersRequest.

Methods​

toJSON()​

toJSON(): object

Converts this CountWorkersRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CountWorkersRequest & $Properties

Creates a new CountWorkersRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CountWorkersRequest & $Properties

CountWorkersRequest instance

Call Signature​

static create(properties?): CountWorkersRequest

Creates a new CountWorkersRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CountWorkersRequest

CountWorkersRequest instance

decode()​

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

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

CountWorkersRequest & $Properties

CountWorkersRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CountWorkersRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CountWorkersRequest & $Properties

CountWorkersRequest

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

Parameters​

message​

$Properties

CountWorkersRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CountWorkersRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CountWorkersRequest

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

Parameters​

object​

Plain object

Returns​

CountWorkersRequest

CountWorkersRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CountWorkersRequest

CountWorkersRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object