RequestQueueHead

Model for request queue head.

Represents a collection of requests retrieved from the beginning of a queue, including metadata about the queue's state and lock information for the requests.

Index

Methods

• from_client_locked_head

Properties

• had_multiple_clients
• items
• limit
• lock_time
• model_config
• queue_has_locked_requests
• queue_modified_at

Methods

from_client_locked_head

• from_client_locked_head(client_locked_head): RequestQueueHead

• Create a RequestQueueHead from an Apify API client's LockedRequestQueueHead model.

  ---

  Parameters

  • client_locked_head: LockedRequestQueueHead

    LockedRequestQueueHead instance from Apify API client.

  Returns RequestQueueHead

  RequestQueueHead instance with properly converted types.

Properties

had_multiple_clients

had_multiple_clients: bool

Indicates whether the queue has been accessed by multiple clients (consumers).

items

items: list[Request]

The list of request objects retrieved from the beginning of the queue.

limit

limit: int | None

The maximum number of requests that were requested from the queue.

lock_time

lock_time: timedelta | None

The duration for which the returned requests are locked and cannot be processed by other clients.

The platform's API names this field lockSecs, so it is serialized under that alias instead of the lockTime that to_camel would derive from the field name.

model_config

model_config: Undefined

queue_has_locked_requests

queue_has_locked_requests: bool | None

Indicates whether the queue contains any locked requests.

queue_modified_at

queue_modified_at: datetime

The timestamp when the queue was last modified.