RequestQueueClient

Sub-client for manipulating a single request queue.

Hierarchy

• ResourceClient
  • RequestQueueClient

Index

Methods

• __init__
• add_request
• delete
• delete_request
• get
• get_request
• list_head
• update
• update_request

Methods

__init__

• __init__(args, *, client_key, kwargs): None

• Overrides ResourceClient.__init__

  Initialize the RequestQueueClient.

  ---

  Parameters

  • args: Any

  • optionalkeyword-onlyclient_key: Optional[str] = None

    A unique identifier of the client accessing the request queue

  • kwargs: Any

  Returns None

add_request

• add_request(request, *, forefront): Dict

• Add a request to the queue.

  https://docs.apify.com/api/v2#/reference/request-queues/request-collection/add-request

  ---

  Parameters

  • request: Dict

    The request to add to the queue

  • optionalkeyword-onlyforefront: Optional[bool] = None

    Whether to add the request to the head or the end of the queue

  Returns Dict

  dict: The added request.

delete

• delete(): None

• Delete the request queue.

  https://docs.apify.com/api/v2#/reference/request-queues/queue/delete-request-queue

  ---

  Returns None

delete_request

• delete_request(request_id): None

• Delete a request from the queue.

  https://docs.apify.com/api/v2#/reference/request-queues/request/delete-request

  ---

  Parameters

  • request_id: str

    ID of the request to delete.

  Returns None

get

• get(): Optional[Dict]

• Retrieve the request queue.

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

  ---

  Returns Optional[Dict]

  dict, optional: The retrieved request queue, or None, if it does not exist

get_request

• get_request(request_id): Optional[Dict]

• Retrieve a request from the queue.

  https://docs.apify.com/api/v2#/reference/request-queues/request/get-request

  ---

  Parameters

  • request_id: str

    ID of the request to retrieve

  Returns Optional[Dict]

  dict, optional: The retrieved request, or None, if it did not exist.

list_head

• list_head(*, limit): Dict

• Retrieve a given number of requests from the beginning of the queue.

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

  ---

  Parameters

  • optionalkeyword-onlylimit: Optional[int] = None

    How many requests to retrieve

  Returns Dict

  dict: The desired number of requests from the beginning of the queue.

update

• update(*, name): Dict

• Update the request queue with specified fields.

  https://docs.apify.com/api/v2#/reference/request-queues/queue/update-request-queue

  ---

  Parameters

  • optionalkeyword-onlyname: Optional[str] = None

    The new name for the request queue

  Returns Dict

  dict: The updated request queue

update_request

• update_request(request, *, forefront): Dict

• Update a request in the queue.

  https://docs.apify.com/api/v2#/reference/request-queues/request/update-request

  ---

  Parameters

  • request: Dict

    The updated request

  • optionalkeyword-onlyforefront: Optional[bool] = None

    Whether to put the updated request in the beginning or the end of the queue

  Returns Dict

  dict: The updated request