Skip to main content

Class: RateLimitConfig

Represents a RateLimitConfig.

Properties​

metadata?​

optional metadata?: $Properties | null

RateLimitConfig metadata.

rateLimit?​

optional rateLimit?: $Properties | null

RateLimitConfig rateLimit.

Methods​

toJSON()​

toJSON(): object

Converts this RateLimitConfig to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RateLimitConfig & $Properties

Creates a new RateLimitConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RateLimitConfig & $Properties

RateLimitConfig instance

Call Signature​

static create(properties?): RateLimitConfig

Creates a new RateLimitConfig instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RateLimitConfig

RateLimitConfig instance

decode()​

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

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

RateLimitConfig & $Properties

RateLimitConfig

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RateLimitConfig & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RateLimitConfig & $Properties

RateLimitConfig

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

Parameters​

message​

$Properties

RateLimitConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RateLimitConfig message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RateLimitConfig

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

Parameters​

object​

Plain object

Returns​

RateLimitConfig

RateLimitConfig

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RateLimitConfig

RateLimitConfig

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object