Skip to main content

Class: TaskQueueConfig

Represents a TaskQueueConfig.

Properties​

fairnessKeysRateLimitDefault?​

optional fairnessKeysRateLimitDefault?: $Properties | null

If set, each individual fairness key will be limited to this rate, scaled by the weight of the fairness key.

fairnessWeightOverrides​

fairnessWeightOverrides: object

If set, overrides the fairness weights for the corresponding fairness keys.

Index Signature​

[k: string]: number

queueRateLimit?​

optional queueRateLimit?: $Properties | null

Unless modified, this is the system-defined rate limit.

Methods​

toJSON()​

toJSON(): object

Converts this TaskQueueConfig to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TaskQueueConfig & $Properties

Creates a new TaskQueueConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueConfig & $Properties

TaskQueueConfig instance

Call Signature​

static create(properties?): TaskQueueConfig

Creates a new TaskQueueConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueConfig

TaskQueueConfig instance

decode()​

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

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

TaskQueueConfig & $Properties

TaskQueueConfig

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TaskQueueConfig & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TaskQueueConfig & $Properties

TaskQueueConfig

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

Parameters​

message​

$Properties

TaskQueueConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TaskQueueConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TaskQueueConfig

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

Parameters​

object​

Plain object

Returns​

TaskQueueConfig

TaskQueueConfig

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TaskQueueConfig

TaskQueueConfig

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object