Class: UpdateTaskQueueConfigRequest

workflowservice.v1.UpdateTaskQueueConfigRequest

Represents an UpdateTaskQueueConfigRequest.

Implements

• IUpdateTaskQueueConfigRequest

Constructors

constructor

• new UpdateTaskQueueConfigRequest(properties?): UpdateTaskQueueConfigRequest

Constructs a new UpdateTaskQueueConfigRequest.

Parameters

Name	Type	Description
properties?	IUpdateTaskQueueConfigRequest	Properties to set

Returns

UpdateTaskQueueConfigRequest

Properties

identity

• identity: string

UpdateTaskQueueConfigRequest identity.

Implementation of

IUpdateTaskQueueConfigRequest.identity

---

namespace

• namespace: string

UpdateTaskQueueConfigRequest namespace.

Implementation of

IUpdateTaskQueueConfigRequest.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

Implementation of

IUpdateTaskQueueConfigRequest.setFairnessWeightOverrides

---

taskQueue

• taskQueue: string

Selects the task queue to update.

Implementation of

IUpdateTaskQueueConfigRequest.taskQueue

---

taskQueueType

• taskQueueType: TaskQueueType

UpdateTaskQueueConfigRequest taskQueueType.

Implementation of

IUpdateTaskQueueConfigRequest.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.

Implementation of

IUpdateTaskQueueConfigRequest.unsetFairnessWeightOverrides

---

updateFairnessKeyRateLimitDefault

• Optional updateFairnessKeyRateLimitDefault: null | IRateLimitUpdate

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.

Implementation of

IUpdateTaskQueueConfigRequest.updateFairnessKeyRateLimitDefault

---

updateQueueRateLimit

• Optional updateQueueRateLimit: null | IRateLimitUpdate

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.

Implementation of

IUpdateTaskQueueConfigRequest.updateQueueRateLimit

Methods

toJSON

▸ toJSON(): Object

Converts this UpdateTaskQueueConfigRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): UpdateTaskQueueConfigRequest

Creates a new UpdateTaskQueueConfigRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IUpdateTaskQueueConfigRequest	Properties to set

Returns

UpdateTaskQueueConfigRequest

UpdateTaskQueueConfigRequest instance

---

decode

▸ decode(reader, length?): UpdateTaskQueueConfigRequest

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

UpdateTaskQueueConfigRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): UpdateTaskQueueConfigRequest

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

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	IUpdateTaskQueueConfigRequest	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	IUpdateTaskQueueConfigRequest	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

UpdateTaskQueueConfigRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for UpdateTaskQueueConfigRequest

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 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