BaseRequestQueueClient
crawlee.base_storage_client._base_request_queue_client.BaseRequestQueueClient
Index
Methods
add_request
Add a request to the queue.
Parameters
request: Request
forefront: bool = Falsekeyword-only
Returns ProcessedRequest
batch_add_requests
Add a batch of requests to the queue.
Parameters
requests: Sequence[Request]
forefront: bool = Falsekeyword-only
Returns BatchRequestsOperationResponse
batch_delete_requests
Delete given requests from the queue.
Parameters
requests: list[Request]
Returns BatchRequestsOperationResponse
delete
Permanently delete the request queue managed by this client.
Returns None
delete_request
Delete a request from the queue.
Parameters
request_id: str
Returns None
delete_request_lock
Delete the lock on a specific request in the queue.
Parameters
request_id: str
forefront: bool = Falsekeyword-only
Returns None
get
Get metadata about the request queue being managed by this client.
Returns RequestQueueMetadata | None
get_request
Retrieve a request from the queue.
Parameters
request_id: str
Returns Request | None
list_and_lock_head
Fetch and lock a specified number of requests from the start of the queue.
Retrieves and locks the first few requests of a queue for the specified duration. This prevents the requests from being fetched by another client until the lock expires.
Parameters
lock_secs: intkeyword-only
limit: int | None = Nonekeyword-only
Returns RequestQueueHeadWithLocks
list_head
Retrieve a given number of requests from the beginning of the queue.
Parameters
limit: int | None = Nonekeyword-only
Returns RequestQueueHead
prolong_request_lock
Prolong the lock on a specific request in the queue.
Parameters
request_id: str
forefront: bool = Falsekeyword-only
lock_secs: intkeyword-only
Returns ProlongRequestLockResponse
update
Update the request queue metadata.
Parameters
name: str | None = Nonekeyword-only
Returns RequestQueueMetadata
update_request
Update a request in the queue.
Parameters
request: Request
forefront: bool = Falsekeyword-only
Returns ProcessedRequest
Abstract base class for request queue resource clients.
These clients are specific to the type of resource they manage and operate under a designated storage client, like a memory storage client.