Queues#

Queue Definition#

A Queue in Dioptra represents a logical job queue, which workers can accept jobs from.

Queue Attributes#

This section describes the attributes that define a Queue.

Required Attributes#

  • Name: (string) The name of the queue.

  • Group: (integer ID) The Group that owns this Queue and controls access permissions.

  • Description: (string) A description of the queue.

System-Managed State#

The following attributes are automatically assigned by the system and cannot be set directly by the user.

  • ID: Unique identifier assigned upon creation.

  • Created On: Timestamp indicating when the Experiment was created.

  • Last Modified On: Timestamp indicating when the Experiment was last modified.

Registration Interfaces#

Queues can be created programmatically via the Python Client or the REST API. They can also be created through the web interface.

Using Python Client#

Create a Queue

QueuesCollectionClient.create(group_id: int, name: str, description: str | None = None) → dioptra.client.queues.T[source]#

Creates a queue.

Parameters

  • group_id – The id of the group that will own the queue.

  • name – The name of the new queue.

  • description – The description of the new queue. Optional, defaults to None.

Returns

The response from the Dioptra API.

Using REST API#

Queues can be created directly via the HTTP API.

Create Queues

See the POST /api/v1/queues endpoint documentation for payload requirements.

See Also#