SDK: queue

The queue area has 5 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

queueList

The project task queue, in priority order; archived=true lists the archived tasks that can still be restored

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/queue

queueList(args: { tenantId: string; projectId: string; query?: { archived?: string } }, options?: CallOptions): Promise<TaskQueue>

queueNext

The next task an executor should take

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/queue/next

queueNext(args: { tenantId: string; projectId: string; query?: { executor?: string; current?: string } }, options?: CallOptions): Promise<NextTask>

queuePolicyGet

Read the task requirement for a project

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/queue/policy

queuePolicyGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<TaskPolicy>

queuePolicyPut

Set the task requirement (task policy class)

• Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/queue/policy

queuePolicyPut(args: { tenantId: string; projectId: string; body: SetTaskPolicyRequest }, options?: CallOptions): Promise<TaskPolicy>

queuePrioritise

Change a task priority

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/queue/{queueId}/prioritise

queuePrioritise(args: { tenantId: string; projectId: string; queueId: string; body: PrioritiseRequest }, options?: CallOptions): Promise<PrioritiseResult>