Class: TaskQueueStatus

taskqueue.v1.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: null | $Properties

TaskQueueStatus taskIdBlock.

Methods

toJSON

▸ toJSON(): Object

Converts this TaskQueueStatus to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TaskQueueStatus & $Properties

Creates a new TaskQueueStatus instance using the specified properties.

Parameters

Name	Type	Description
properties?	$Properties	Properties to set

Returns

TaskQueueStatus & $Properties

TaskQueueStatus instance

▸ create(properties?): TaskQueueStatus

Parameters

Name	Type
properties?	$Properties

Returns

TaskQueueStatus

---

decode

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

Decodes a TaskQueueStatus message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | 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

▸ decodeDelimited(reader): TaskQueueStatus & $Properties

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

Parameters

Name	Type	Description
reader	Uint8Array | 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

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	$Properties	TaskQueueStatus message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	$Properties	TaskQueueStatus message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TaskQueueStatus

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TaskQueueStatus

TaskQueueStatus

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	TaskQueueStatus	TaskQueueStatus
options?	IConversionOptions	Conversion options

Returns

Object

Plain object