Skip to main content

Class: 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?: $Properties | null

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?: $Properties | null

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()​

Call Signature​

static create(properties?): UpdateTaskQueueConfigRequest & $Properties

Creates a new UpdateTaskQueueConfigRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateTaskQueueConfigRequest & $Properties

UpdateTaskQueueConfigRequest instance

Call Signature​

static create(properties?): UpdateTaskQueueConfigRequest

Creates a new UpdateTaskQueueConfigRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateTaskQueueConfigRequest

UpdateTaskQueueConfigRequest instance

decode()​

static decode(reader, length?): UpdateTaskQueueConfigRequest & $Properties

Decodes an UpdateTaskQueueConfigRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): UpdateTaskQueueConfigRequest & $Properties

Decodes an UpdateTaskQueueConfigRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified UpdateTaskQueueConfigRequest message. Does not implicitly temporal.api.workflowservice.v1.UpdateTaskQueueConfigRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateTaskQueueConfigRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified UpdateTaskQueueConfigRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateTaskQueueConfigRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateTaskQueueConfigRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateTaskQueueConfigRequest

Creates an UpdateTaskQueueConfigRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

UpdateTaskQueueConfigRequest

UpdateTaskQueueConfigRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from an UpdateTaskQueueConfigRequest message. Also converts values to other types if specified.

Parameters​

message​

UpdateTaskQueueConfigRequest

UpdateTaskQueueConfigRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object