Class: RateLimitConfig
Represents a RateLimitConfig.
Implements
Constructors
constructor
• new RateLimitConfig(properties?): RateLimitConfig
Constructs a new RateLimitConfig.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRateLimitConfig | Properties to set |
Returns
Properties
metadata
• Optional metadata: null | IConfigMetadata
RateLimitConfig metadata.
Implementation of
rateLimit
• Optional rateLimit: null | IRateLimit
RateLimitConfig rateLimit.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this RateLimitConfig to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RateLimitConfig
Creates a new RateLimitConfig instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRateLimitConfig | Properties to set |
Returns
RateLimitConfig instance
decode
▸ decode(reader, length?): RateLimitConfig
Decodes a RateLimitConfig 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
RateLimitConfig
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RateLimitConfig
Decodes a RateLimitConfig message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RateLimitConfig
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 RateLimitConfig message. Does not implicitly temporal.api.taskqueue.v1.RateLimitConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRateLimitConfig | RateLimitConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RateLimitConfig message, length delimited. Does not implicitly temporal.api.taskqueue.v1.RateLimitConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRateLimitConfig | RateLimitConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RateLimitConfig
Creates a RateLimitConfig message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RateLimitConfig
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RateLimitConfig
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 RateLimitConfig message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RateLimitConfig | RateLimitConfig |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object