Skip to main content

Class: EffectiveRateLimit

Represents an EffectiveRateLimit.

Properties​

rateLimitSource​

rateLimitSource: RateLimitSource

Source of the RateLimit Configuration,which can be one of the following values:

  • SOURCE_API: The rate limit that is set via the TaskQueueConfig api.
  • SOURCE_WORKER: The rate limit is the value set using the workerOptions in TaskQueueActivitiesPerSecond.
  • SOURCE_SYSTEM: The rate limit is the default value set by the system

requestsPerSecond​

requestsPerSecond: number

The effective rate limit for the task queue.

Methods​

toJSON()​

toJSON(): object

Converts this EffectiveRateLimit to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): EffectiveRateLimit & $Properties

Creates a new EffectiveRateLimit instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EffectiveRateLimit & $Properties

EffectiveRateLimit instance

Call Signature​

static create(properties?): EffectiveRateLimit

Creates a new EffectiveRateLimit instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EffectiveRateLimit

EffectiveRateLimit instance

decode()​

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

Decodes an EffectiveRateLimit 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​

EffectiveRateLimit & $Properties

EffectiveRateLimit

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EffectiveRateLimit & $Properties

Decodes an EffectiveRateLimit message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

EffectiveRateLimit & $Properties

EffectiveRateLimit

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

Parameters​

message​

$Properties

EffectiveRateLimit message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

EffectiveRateLimit message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EffectiveRateLimit

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

Parameters​

object​

Plain object

Returns​

EffectiveRateLimit

EffectiveRateLimit

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

EffectiveRateLimit

EffectiveRateLimit

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object