Skip to main content

Class: WorkerSlotsInfo

Represents a WorkerSlotsInfo.

Properties​

currentAvailableSlots​

currentAvailableSlots: number

Number of slots available for the worker to specific tasks. May be -1 if the upper bound is not known.

currentUsedSlots​

currentUsedSlots: number

Number of slots used by the worker for specific tasks.

lastIntervalFailureTasks​

lastIntervalFailureTasks: number

Number of failed tasks processed since the last heartbeat from the worker.

lastIntervalProcessedTasks​

lastIntervalProcessedTasks: number

Number of tasks processed in since the last heartbeat from the worker. This is a cumulative counter, and it is reset to 0 each time the worker sends a heartbeat. Contains both successful and failed tasks.

slotSupplierKind​

slotSupplierKind: string

Kind of the slot supplier, which is used to determine how the slots are allocated. Possible values: "Fixed | ResourceBased | Custom String"

totalFailedTasks​

totalFailedTasks: number

Total number of failed tasks processed by the worker so far.

totalProcessedTasks​

totalProcessedTasks: number

Total number of tasks processed (completed both successfully and unsuccesfully, or any other way) by the worker since the worker started. This is a cumulative counter.

Methods​

toJSON()​

toJSON(): object

Converts this WorkerSlotsInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkerSlotsInfo & $Properties

Creates a new WorkerSlotsInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerSlotsInfo & $Properties

WorkerSlotsInfo instance

Call Signature​

static create(properties?): WorkerSlotsInfo

Creates a new WorkerSlotsInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkerSlotsInfo

WorkerSlotsInfo instance

decode()​

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

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

WorkerSlotsInfo & $Properties

WorkerSlotsInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkerSlotsInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkerSlotsInfo & $Properties

WorkerSlotsInfo

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

Parameters​

message​

$Properties

WorkerSlotsInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkerSlotsInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkerSlotsInfo

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

Parameters​

object​

Plain object

Returns​

WorkerSlotsInfo

WorkerSlotsInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkerSlotsInfo

WorkerSlotsInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object