RequestQueueClient

apify_client.clients.RequestQueueClient

Sub-client for manipulating a single request queue.

Index

Methods

• add_request
• batch_add_requests
• batch_delete_requests
• delete
• delete_request
• delete_request_lock
• get
• get_request
• list_and_lock_head
• list_head
• list_requests
• prolong_request_lock
• update
• update_request

Methods

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

  • forefront: bool | None = Nonekeyword-only

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

  Returns dict

  The added request.

batch_add_requests

• batch_add_requests(requests, *, forefront): dict

• Add requests to the queue.

  https://docs.apify.com/api/v2#/reference/request-queues/batch-request-operations/add-requests

  ---

  Parameters

  • requests: list[dict]

    list of the requests to add

  • forefront: bool | None = Nonekeyword-only

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

  Returns dict

batch_delete_requests

• batch_delete_requests(requests): dict

• Delete given requests from the queue.

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

  ---

  Parameters

  • requests: list[dict]

    list of the requests to delete

  Returns dict

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

delete_request_lock

• delete_request_lock(request_id, *, forefront): None

• Delete the lock on a request.

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

  ---

  Parameters

  • request_id: str

    ID of the request to delete the lock

  • forefront: bool | None = Nonekeyword-only

    Whether to put the request in the beginning or the end of the queue after the lock is deleted

  Returns None

get

• get(): dict | None

• Retrieve the request queue.

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

  ---

  Returns dict | None

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

get_request

• get_request(request_id): dict | None

• 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 dict | None

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

list_and_lock_head

• list_and_lock_head(*, lock_secs, limit): dict

• Retrieve a given number of unlocked requests from the beginning of the queue and lock them for a given time.

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

  ---

  Parameters

  • lock_secs: intkeyword-only

    How long the requests will be locked for, in seconds

  • limit: int | None = Nonekeyword-only

    How many requests to retrieve

  Returns dict

  The desired number of locked requests from the beginning of the queue.

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

  • limit: int | None = Nonekeyword-only

    How many requests to retrieve

  Returns dict

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

list_requests

• list_requests(*, limit, exclusive_start_id): dict

• List requests in the queue.

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

  ---

  Parameters

  • limit: int | None = Nonekeyword-only

    How many requests to retrieve

  • exclusive_start_id: str | None = Nonekeyword-only

    All requests up to this one (including) are skipped from the result

  Returns dict

prolong_request_lock

• prolong_request_lock(request_id, *, forefront, lock_secs): dict

• Prolong the lock on a request.

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

  ---

  Parameters

  • request_id: str

    ID of the request to prolong the lock

  • forefront: bool | None = Nonekeyword-only

    Whether to put the request in the beginning or the end of the queue after lock expires

  • lock_secs: intkeyword-only

    By how much to prolong the lock, in seconds

  Returns dict

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

  • name: str | None = Nonekeyword-only

    The new name for the request queue

  Returns 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

  • forefront: bool | None = Nonekeyword-only

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

  Returns dict

  The updated request