BaseRequestQueueCollectionClient

Abstract base class for request queue collection clients.

This collection client handles operations that involve multiple instances of a given resource type.

Hierarchy

• BaseRequestQueueCollectionClient
  • RequestQueueCollectionClient

Index

Methods

• get_or_create
• list

Methods

get_or_create

• async get_or_create(*, id, name, schema): RequestQueueMetadata

• Retrieve an existing request queue by its name or ID, or create a new one if it does not exist.

  ---

  Parameters

  • keyword-onlyid: str | None = None

    Optional ID of the request queue to retrieve or create. If provided, the method will attempt to find a request queue with the ID.

  • keyword-onlyname: str | None = None

    Optional name of the request queue resource to retrieve or create. If provided, the method will attempt to find a request queue with this name.

  • keyword-onlyschema: dict | None = None

    Optional schema for the request queue resource to be created.

  Returns RequestQueueMetadata

  Metadata object containing the information of the retrieved or created request queue.

list

• async list(*, unnamed, limit, offset, desc): RequestQueueListPage

• List the available request queues.

  ---

  Parameters

  • keyword-onlyunnamed: bool = False

    Whether to list only the unnamed request queues.

  • keyword-onlylimit: int | None = None

    Maximum number of request queues to return.

  • keyword-onlyoffset: int | None = None

    Number of request queues to skip from the beginning of the list.

  • keyword-onlydesc: bool = False

    Whether to sort the request queues in descending order.

  Returns RequestQueueListPage

  The list of available request queues matching the specified filters.