Skip to main content

Class: TaskQueueStatus

Deprecated. Use InternalTaskQueueStatus. This is kept until DescribeTaskQueue supports legacy behavior.

Properties​

ackLevel​

ackLevel: Long

TaskQueueStatus ackLevel.

backlogCountHint​

backlogCountHint: Long

TaskQueueStatus backlogCountHint.

ratePerSecond​

ratePerSecond: number

TaskQueueStatus ratePerSecond.

readLevel​

readLevel: Long

TaskQueueStatus readLevel.

taskIdBlock?​

optional taskIdBlock?: $Properties | null

TaskQueueStatus taskIdBlock.

Methods​

toJSON()​

toJSON(): object

Converts this TaskQueueStatus to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TaskQueueStatus & $Properties

Creates a new TaskQueueStatus instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueStatus & $Properties

TaskQueueStatus instance

Call Signature​

static create(properties?): TaskQueueStatus

Creates a new TaskQueueStatus instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueStatus

TaskQueueStatus instance

decode()​

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

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

TaskQueueStatus & $Properties

TaskQueueStatus

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TaskQueueStatus & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TaskQueueStatus & $Properties

TaskQueueStatus

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

Parameters​

message​

$Properties

TaskQueueStatus message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TaskQueueStatus message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

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

message​

TaskQueueStatus

TaskQueueStatus

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object