Skip to main content

Class: RateLimit

Represents a RateLimit.

Properties​

requestsPerSecond​

requestsPerSecond: number

Zero is a valid rate limit.

Methods​

toJSON()​

toJSON(): object

Converts this RateLimit to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RateLimit & $Properties

Creates a new RateLimit instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RateLimit & $Properties

RateLimit instance

Call Signature​

static create(properties?): RateLimit

Creates a new RateLimit instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RateLimit

RateLimit instance

decode()​

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

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

RateLimit & $Properties

RateLimit

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RateLimit & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RateLimit & $Properties

RateLimit

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

Parameters​

message​

$Properties

RateLimit message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RateLimit message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RateLimit

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

Parameters​

object​

Plain object

Returns​

RateLimit

RateLimit

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RateLimit

RateLimit

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object