Skip to main content

Class: TaskQueue

taskqueue.v1.TaskQueue

Represents a TaskQueue.

Implements#

Constructors#

constructor#

new TaskQueue(properties?)

Constructs a new TaskQueue.

Parameters#

NameType
properties?ITaskQueue

Properties#

kind#

kind: TaskQueueKind

TaskQueue kind.

Implementation of#

ITaskQueue.kind


name#

name: string

TaskQueue name.

Implementation of#

ITaskQueue.name

Methods#

toJSON#

toJSON(): Object

Converts this TaskQueue to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): TaskQueue

Decodes a TaskQueue message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

TaskQueue

TaskQueue


decodeDelimited#

Static decodeDelimited(reader): TaskQueue

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

TaskQueue

TaskQueue


encode#

Static encode(message, writer?): Writer

Encodes the specified TaskQueue message. Does not implicitly {@link temporal.api.taskqueue.v1.TaskQueue.verify|verify} messages.

Parameters#

NameTypeDescription
messageITaskQueueTaskQueue message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

NameTypeDescription
messageITaskQueueTaskQueue message or plain object to encode
writer?Writer-

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageTaskQueueTaskQueue
options?IConversionOptions-

Returns#

Object

Plain object