Skip to main content

Class: TaskQueueMetadata

Only applies to activity task queues

Properties​

maxTasksPerSecond?​

optional maxTasksPerSecond?: $Properties | null

Allows throttling dispatch of tasks from this queue

Methods​

toJSON()​

toJSON(): object

Converts this TaskQueueMetadata to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TaskQueueMetadata & $Properties

Creates a new TaskQueueMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueMetadata & $Properties

TaskQueueMetadata instance

Call Signature​

static create(properties?): TaskQueueMetadata

Creates a new TaskQueueMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueMetadata

TaskQueueMetadata instance

decode()​

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

Decodes a TaskQueueMetadata 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​

TaskQueueMetadata & $Properties

TaskQueueMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TaskQueueMetadata & $Properties

Decodes a TaskQueueMetadata message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TaskQueueMetadata & $Properties

TaskQueueMetadata

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 TaskQueueMetadata message. Does not implicitly temporal.api.taskqueue.v1.TaskQueueMetadata.verify|verify messages.

Parameters​

message​

$Properties

TaskQueueMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TaskQueueMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TaskQueueMetadata

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

Parameters​

object​

Plain object

Returns​

TaskQueueMetadata

TaskQueueMetadata

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TaskQueueMetadata

TaskQueueMetadata

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object