Class: EffectiveRateLimit
v1.DescribeTaskQueueResponse.EffectiveRateLimit
Represents an EffectiveRateLimit.
Implements
Constructors
constructor
• new EffectiveRateLimit(properties?): EffectiveRateLimit
Constructs a new EffectiveRateLimit.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEffectiveRateLimit | Properties to set |
Returns
Properties
rateLimitSource
• rateLimitSource: RateLimitSource
Source of the RateLimit Configuration,which can be one of the following values:
- SOURCE_API: The rate limit that is set via the TaskQueueConfig api.
- SOURCE_WORKER: The rate limit is the value set using the workerOptions in TaskQueueActivitiesPerSecond.
- SOURCE_SYSTEM: The rate limit is the default value set by the system
Implementation of
IEffectiveRateLimit.rateLimitSource
requestsPerSecond
• requestsPerSecond: number
The effective rate limit for the task queue.
Implementation of
IEffectiveRateLimit.requestsPerSecond
Methods
toJSON
▸ toJSON(): Object
Converts this EffectiveRateLimit to JSON.
Returns
Object
JSON object
create
▸ create(properties?): EffectiveRateLimit
Creates a new EffectiveRateLimit instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEffectiveRateLimit | Properties to set |
Returns
EffectiveRateLimit instance
decode
▸ decode(reader, length?): EffectiveRateLimit
Decodes an EffectiveRateLimit 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
EffectiveRateLimit
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): EffectiveRateLimit
Decodes an EffectiveRateLimit message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
EffectiveRateLimit
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 EffectiveRateLimit message. Does not implicitly temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEffectiveRateLimit | EffectiveRateLimit message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified EffectiveRateLimit message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeTaskQueueResponse.EffectiveRateLimit.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEffectiveRateLimit | EffectiveRateLimit message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): EffectiveRateLimit
Creates an EffectiveRateLimit message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
EffectiveRateLimit
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for EffectiveRateLimit
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 an EffectiveRateLimit message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | EffectiveRateLimit | EffectiveRateLimit |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object