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