Skip to main content

Class: TaskQueueStatus

taskqueue.v1.TaskQueueStatus

Represents a TaskQueueStatus.

Implements#

Constructors#

constructor#

new TaskQueueStatus(properties?)

Constructs a new TaskQueueStatus.

Parameters#

NameType
properties?ITaskQueueStatus

Properties#

ackLevel#

ackLevel: Long

TaskQueueStatus ackLevel.

Implementation of#

ITaskQueueStatus.ackLevel


backlogCountHint#

backlogCountHint: Long

TaskQueueStatus backlogCountHint.

Implementation of#

ITaskQueueStatus.backlogCountHint


ratePerSecond#

ratePerSecond: number

TaskQueueStatus ratePerSecond.

Implementation of#

ITaskQueueStatus.ratePerSecond


readLevel#

readLevel: Long

TaskQueueStatus readLevel.

Implementation of#

ITaskQueueStatus.readLevel


taskIdBlock#

Optional taskIdBlock: null | ITaskIdBlock

TaskQueueStatus taskIdBlock.

Implementation of#

ITaskQueueStatus.taskIdBlock

Methods#

toJSON#

toJSON(): Object

Converts this TaskQueueStatus to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): TaskQueueStatus

Decodes a TaskQueueStatus 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#

TaskQueueStatus

TaskQueueStatus


decodeDelimited#

Static decodeDelimited(reader): TaskQueueStatus

Decodes a TaskQueueStatus 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#

TaskQueueStatus

TaskQueueStatus


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): TaskQueueStatus

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

TaskQueueStatus

TaskQueueStatus


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageTaskQueueStatusTaskQueueStatus
options?IConversionOptions-

Returns#

Object

Plain object