Class: VersionTaskQueue
v1.DescribeWorkerDeploymentVersionResponse.VersionTaskQueue
(-- api-linter: core::0123::resource-annotation=disabled --)
Properties
name
• name: string
VersionTaskQueue name.
stats
• Optional stats: null | $Properties
Only set if report_task_queue_stats is set on the request.
statsByPriorityKey
• statsByPriorityKey: Object
Task queue stats breakdown by priority key. Only contains actively used priority keys.
Only set if report_task_queue_stats is set to true in the request.
(-- api-linter: core::0140::prepositions=disabled
aip.dev/not-precedent: "by" is used to clarify the key. --)
Index signature
▪ [k: string]: $Properties
type
• type: TaskQueueType
VersionTaskQueue type.
Methods
toJSON
▸ toJSON(): Object
Converts this VersionTaskQueue to JSON.
Returns
Object
JSON object
create
▸ create(properties?): VersionTaskQueue & $Properties
Creates a new VersionTaskQueue instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
VersionTaskQueue & $Properties
VersionTaskQueue instance
▸ create(properties?): VersionTaskQueue
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): VersionTaskQueue & $Properties
Decodes a VersionTaskQueue 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
VersionTaskQueue & $Properties
VersionTaskQueue
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): VersionTaskQueue & $Properties
Decodes a VersionTaskQueue message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
VersionTaskQueue & $Properties
VersionTaskQueue
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 VersionTaskQueue message. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentVersionResponse.VersionTaskQueue.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | VersionTaskQueue message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified VersionTaskQueue message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentVersionResponse.VersionTaskQueue.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | VersionTaskQueue message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): VersionTaskQueue
Creates a VersionTaskQueue message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
VersionTaskQueue
toObject
▸ toObject(message, options?): Object
Creates a plain object from a VersionTaskQueue message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | VersionTaskQueue | VersionTaskQueue |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object