Class: UpdateTaskQueueConfigRequest
workflowservice.v1.UpdateTaskQueueConfigRequest
Represents an UpdateTaskQueueConfigRequest.
Properties
identity
• identity: string
UpdateTaskQueueConfigRequest identity.
namespace
• namespace: string
UpdateTaskQueueConfigRequest namespace.
setFairnessWeightOverrides
• setFairnessWeightOverrides: Object
If set, overrides the fairness weight for each specified fairness key. Fairness keys not listed in this map will keep their existing overrides (if any).
Index signature
▪ [k: string]: number
taskQueue
• taskQueue: string
Selects the task queue to update.
taskQueueType
• taskQueueType: TaskQueueType
UpdateTaskQueueConfigRequest taskQueueType.
unsetFairnessWeightOverrides
• unsetFairnessWeightOverrides: string[]
If set, removes any existing fairness weight overrides for each specified fairness key. Fairness weights for corresponding keys fall back to the values set during task creation (if any), or to the default weight of 1.0.
updateFairnessKeyRateLimitDefault
• Optional updateFairnessKeyRateLimitDefault: null | $Properties
Update to the default fairness key rate limit.
If not set, this configuration is unchanged.
If the rate_limit field in the RateLimitUpdate is missing, remove the existing rate limit.
updateQueueRateLimit
• Optional updateQueueRateLimit: null | $Properties
Update to queue-wide rate limit.
If not set, this configuration is unchanged.
NOTE: A limit set by the worker is overriden; and restored again when reset.
If the rate_limit field in the RateLimitUpdate is missing, remove the existing rate limit.
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateTaskQueueConfigRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateTaskQueueConfigRequest & $Properties
Creates a new UpdateTaskQueueConfigRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
UpdateTaskQueueConfigRequest & $Properties
UpdateTaskQueueConfigRequest instance
▸ create(properties?): UpdateTaskQueueConfigRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): UpdateTaskQueueConfigRequest & $Properties
Decodes an UpdateTaskQueueConfigRequest 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
UpdateTaskQueueConfigRequest & $Properties
UpdateTaskQueueConfigRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateTaskQueueConfigRequest & $Properties
Decodes an UpdateTaskQueueConfigRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateTaskQueueConfigRequest & $Properties
UpdateTaskQueueConfigRequest
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 UpdateTaskQueueConfigRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateTaskQueueConfigRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateTaskQueueConfigRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateTaskQueueConfigRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateTaskQueueConfigRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | UpdateTaskQueueConfigRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateTaskQueueConfigRequest
Creates an UpdateTaskQueueConfigRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateTaskQueueConfigRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from an UpdateTaskQueueConfigRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateTaskQueueConfigRequest | UpdateTaskQueueConfigRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object