Skip to main content
Version: Next

RequestQueueCollectionClient

Sub-client for the request queue collection.

Provides methods to manage the request queue collection, e.g. list or create request queues. Obtain an instance via an appropriate method on the ApifyClient class.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, public_base_url, http_client, resource_path, client_registry, resource_id, params): None

  • Initialize the resource client.

    Parameters

    • keyword-onlybase_url: str

      API base URL.

    • keyword-onlypublic_base_url: str

      Public CDN base URL.

    • keyword-onlyhttp_client: HttpClient

      HTTP client for making requests.

    • keyword-onlyresource_path: str

      Resource endpoint path (e.g., 'actors', 'datasets').

    • keyword-onlyclient_registry: ClientRegistry

      Bundle of client classes for dependency injection.

    • optionalkeyword-onlyresource_id: str | None = None

      Optional resource ID for single-resource clients.

    • optionalkeyword-onlyparams: dict | None = None

      Optional default parameters for all requests.

    Returns None

get_or_create

iterate

  • iterate(*, unnamed, limit, offset, desc, ownership, timeout): Iterator[RequestQueueShort]

  • Iterate over the available request queues.

    Simple list does only one API call, possibly not listing all items matching the criteria. This method returns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.

    https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues

    Parameters

    • optionalkeyword-onlyunnamed: bool | None = None

      Whether to include unnamed request queues in the list.

    • optionalkeyword-onlylimit: int | None = None

      How many request queues to retrieve.

    • optionalkeyword-onlyoffset: int | None = None

      What request queue to include as first when retrieving the list.

    • optionalkeyword-onlydesc: bool | None = None

      Whether to sort the request queues in descending order based on their modification date.

    • optionalkeyword-onlyownership: StorageOwnership | None = None

      Filter by ownership. 'ownedByMe' returns only user's own request queues, 'sharedWithMe' returns only request queues shared with the user.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns Iterator[RequestQueueShort]

list

  • List the available request queues.

    https://docs.apify.com/api/v2#/reference/request-queues/queue-collection/get-list-of-request-queues

    Parameters

    • optionalkeyword-onlyunnamed: bool | None = None

      Whether to include unnamed request queues in the list.

    • optionalkeyword-onlylimit: int | None = None

      How many request queues to retrieve.

    • optionalkeyword-onlyoffset: int | None = None

      What request queue to include as first when retrieving the list.

    • optionalkeyword-onlydesc: bool | None = None

      Whether to sort the request queues in descending order based on their modification date.

    • optionalkeyword-onlyownership: StorageOwnership | None = None

      Filter by ownership. 'ownedByMe' returns only user's own request queues, 'sharedWithMe' returns only request queues shared with the user.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns ListOfRequestQueues

    The list of available request queues matching the specified filters.

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options