Class: RateLimit
Represents a RateLimit.
Implements
Constructors
constructor
• new RateLimit(properties?): RateLimit
Constructs a new RateLimit.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRateLimit | Properties to set |
Returns
Properties
requestsPerSecond
• requestsPerSecond: number
Zero is a valid rate limit.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this RateLimit to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RateLimit
Creates a new RateLimit instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRateLimit | Properties to set |
Returns
RateLimit instance
decode
▸ decode(reader, length?): RateLimit
Decodes a RateLimit message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
RateLimit
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RateLimit
Decodes a RateLimit message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RateLimit
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified RateLimit message. Does not implicitly temporal.api.taskqueue.v1.RateLimit.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRateLimit | RateLimit message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RateLimit message, length delimited. Does not implicitly temporal.api.taskqueue.v1.RateLimit.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRateLimit | RateLimit message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RateLimit
Creates a RateLimit message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RateLimit
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RateLimit
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RateLimit message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RateLimit | RateLimit |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object