Skip to main content

Class: RateLimitUpdate

Represents a RateLimitUpdate.

Properties​

rateLimit?​

optional rateLimit?: $Properties | null

Rate Limit to be updated

reason​

reason: string

Reason for why the rate limit was set.

Methods​

toJSON()​

toJSON(): object

Converts this RateLimitUpdate to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RateLimitUpdate & $Properties

Creates a new RateLimitUpdate instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RateLimitUpdate & $Properties

RateLimitUpdate instance

Call Signature​

static create(properties?): RateLimitUpdate

Creates a new RateLimitUpdate instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RateLimitUpdate

RateLimitUpdate instance

decode()​

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

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

RateLimitUpdate & $Properties

RateLimitUpdate

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RateLimitUpdate & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RateLimitUpdate & $Properties

RateLimitUpdate

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

Parameters​

message​

$Properties

RateLimitUpdate message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RateLimitUpdate message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RateLimitUpdate

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

Parameters​

object​

Plain object

Returns​

RateLimitUpdate

RateLimitUpdate

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RateLimitUpdate

RateLimitUpdate

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object