Skip to main content

Class: TaskQueue

See https://docs.temporal.io/docs/concepts/task-queues/

Properties​

kind​

kind: TaskQueueKind

Default: TASK_QUEUE_KIND_NORMAL.

name​

name: string

TaskQueue name.

normalName​

normalName: string

Iff kind == TASK_QUEUE_KIND_STICKY, then this field contains the name of the normal task queue that the sticky worker is running on.

Methods​

toJSON()​

toJSON(): object

Converts this TaskQueue to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TaskQueue & $Properties

Creates a new TaskQueue instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueue & $Properties

TaskQueue instance

Call Signature​

static create(properties?): TaskQueue

Creates a new TaskQueue instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueue

TaskQueue instance

decode()​

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

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

TaskQueue & $Properties

TaskQueue

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TaskQueue & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TaskQueue & $Properties

TaskQueue

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

Parameters​

message​

$Properties

TaskQueue message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TaskQueue message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TaskQueue

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

Parameters​

object​

Plain object

Returns​

TaskQueue

TaskQueue

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TaskQueue

TaskQueue

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object