Class: TaskQueueConfig
Represents a TaskQueueConfig.
Properties
fairnessKeysRateLimitDefault
• Optional fairnessKeysRateLimitDefault: null | $Properties
If set, each individual fairness key will be limited to this rate, scaled by the weight of the fairness key.
fairnessWeightOverrides
• fairnessWeightOverrides: Object
If set, overrides the fairness weights for the corresponding fairness keys.
Index signature
▪ [k: string]: number
queueRateLimit
• Optional queueRateLimit: null | $Properties
Unless modified, this is the system-defined rate limit.
Methods
toJSON
▸ toJSON(): Object
Converts this TaskQueueConfig to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TaskQueueConfig & $Properties
Creates a new TaskQueueConfig instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
TaskQueueConfig instance
▸ create(properties?): TaskQueueConfig
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): TaskQueueConfig & $Properties
Decodes a TaskQueueConfig 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
TaskQueueConfig
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TaskQueueConfig & $Properties
Decodes a TaskQueueConfig message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TaskQueueConfig
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 TaskQueueConfig message. Does not implicitly temporal.api.taskqueue.v1.TaskQueueConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TaskQueueConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TaskQueueConfig message, length delimited. Does not implicitly temporal.api.taskqueue.v1.TaskQueueConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TaskQueueConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TaskQueueConfig
Creates a TaskQueueConfig message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TaskQueueConfig
toObject
▸ toObject(message, options?): Object
Creates a plain object from a TaskQueueConfig message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TaskQueueConfig | TaskQueueConfig |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object