queues
Creates, updates, deletes, gets or lists a queues resource.
Overview​
| Name | queues |
| Type | Resource |
| Id | nvidia.nvcf_queues.queues |
Fields​
The following fields are returned by SELECT queries:
- list_version
- list
| Name | Datatype | Description |
|---|---|---|
function_version_id | string (uuid) | Function version id (wire: functionVersionId) |
function_name | string (UTF-8) | Function name (wire: functionName) |
function_status | string (UTF-8) | Function status (ACTIVE, DEPLOYING, ERROR, INACTIVE, DELETED, DEGRADED, DEGRADING) (wire: functionStatus) |
queue_depth | integer (int32) | Approximate number of messages in the request queue (wire: queueDepth) |
| Name | Datatype | Description |
|---|---|---|
function_version_id | string (uuid) | Function version id (wire: functionVersionId) |
function_name | string (UTF-8) | Function name (wire: functionName) |
function_status | string (UTF-8) | Function status (ACTIVE, DEPLOYING, ERROR, INACTIVE, DELETED, DEGRADED, DEGRADING) (wire: functionStatus) |
queue_depth | integer (int32) | Approximate number of messages in the request queue (wire: queueDepth) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_version | select | function_id, version_id | Provides details of all the queues associated with the specified function. If a function has multiple versions and they are all deployed, then the response includes details of all the queues. If the specified function is public, then Account Admin cannot perform this operation. Requires a bearer token or an api-key with 'queue_details' scope in the HTTP Authorization header. | |
list | select | function_id | Provides details of all the queues associated with the specified function. If a function has multiple versions and they are all deployed, then the response includes details of all the queues. If the specified function is public, then Account Admin cannot perform this operation. Requires a bearer token or an api-key with 'queue_details' scope in the HTTP Authorization header. |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
function_id | string (uuid) | Function id |
version_id | string (uuid) | Function version id |
SELECT examples​
- list_version
- list
Provides details of all the queues associated with the specified function. If a function has multiple versions and they are all deployed, then the response includes details of all the queues. If the specified function is public, then Account Admin cannot perform this operation. Requires a bearer token or an api-key with 'queue_details' scope in the HTTP Authorization header.
SELECT
function_version_id,
function_name,
function_status,
queue_depth
FROM nvidia.nvcf_queues.queues
WHERE function_id = '{{ function_id }}' -- required
AND version_id = '{{ version_id }}' -- required
;
Provides details of all the queues associated with the specified function. If a function has multiple versions and they are all deployed, then the response includes details of all the queues. If the specified function is public, then Account Admin cannot perform this operation. Requires a bearer token or an api-key with 'queue_details' scope in the HTTP Authorization header.
SELECT
function_version_id,
function_name,
function_status,
queue_depth
FROM nvidia.nvcf_queues.queues
WHERE function_id = '{{ function_id }}' -- required
;