Class: TaskQueueStatus
Deprecated. Use InternalTaskQueueStatus. This is kept until DescribeTaskQueue supports legacy behavior.
Implements
Constructors
constructor
• new TaskQueueStatus(properties?): TaskQueueStatus
Constructs a new TaskQueueStatus.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITaskQueueStatus | Properties to set |
Returns
Properties
ackLevel
• ackLevel: Long
TaskQueueStatus ackLevel.
Implementation of
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
taskIdBlock
• Optional taskIdBlock: null | ITaskIdBlock
TaskQueueStatus taskIdBlock.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this TaskQueueStatus to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TaskQueueStatus
Creates a new TaskQueueStatus instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITaskQueueStatus | Properties to set |
Returns
TaskQueueStatus instance
decode
▸ decode(reader, length?): TaskQueueStatus
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TaskQueueStatus
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
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 | ITaskQueueStatus | 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 | ITaskQueueStatus | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for TaskQueueStatus
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
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