RequestQueueClient

Subclient for manipulating a single request queue.

Hierarchy

• BaseRequestQueueClient
  • RequestQueueClient

Index

Constructors

• __init__

Methods

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

Properties

• resource_directory
• resource_info

Constructors

__init__

• __init__(*, memory_storage_client, id, name, created_at, accessed_at, modified_at, handled_request_count, pending_request_count): None

• Parameters

  • keyword-onlymemory_storage_client: MemoryStorageClient

  • keyword-onlyid: str | None = None

  • keyword-onlyname: str | None = None

  • keyword-onlycreated_at: datetime | None = None

  • keyword-onlyaccessed_at: datetime | None = None

  • keyword-onlymodified_at: datetime | None = None

  • keyword-onlyhandled_request_count: int = 0

  • keyword-onlypending_request_count: int = 0

  Returns None

Methods

add_request

• async add_request(request, *, forefront): ProcessedRequest

• Parameters

  • request: Request

  • keyword-onlyforefront: bool = False

  Returns ProcessedRequest

batch_add_requests

• async batch_add_requests(requests, *, forefront): BatchRequestsOperationResponse

• Parameters

  • requests: Sequence[Request]

  • keyword-onlyforefront: bool = False

  Returns BatchRequestsOperationResponse

batch_delete_requests

• async batch_delete_requests(requests): BatchRequestsOperationResponse

• Parameters

  • requests: list[Request]

  Returns BatchRequestsOperationResponse

delete

• async delete(): None

• Returns None

delete_request

• async delete_request(request_id): None

• Parameters

  • request_id: str

  Returns None

delete_request_lock

• async delete_request_lock(request_id, *, forefront): None

• Parameters

  • request_id: str

  • keyword-onlyforefront: bool = False

  Returns None

get

• async get(): RequestQueueMetadata | None

• Returns RequestQueueMetadata | None

get_request

• async get_request(request_id): Request | None

• Parameters

  • request_id: str

  Returns Request | None

list_and_lock_head

• async list_and_lock_head(*, lock_secs, limit): RequestQueueHeadWithLocks

• Parameters

  • keyword-onlylock_secs: int

  • keyword-onlylimit: int | None = None

  Returns RequestQueueHeadWithLocks

list_head

• async list_head(*, limit): RequestQueueHead

• Parameters

  • keyword-onlylimit: int | None = None

  Returns RequestQueueHead

prolong_request_lock

• async prolong_request_lock(request_id, *, forefront, lock_secs): ProlongRequestLockResponse

• Parameters

  • request_id: str

  • keyword-onlyforefront: bool = False

  • keyword-onlylock_secs: int

  Returns ProlongRequestLockResponse

update

• async update(*, name): RequestQueueMetadata

• Parameters

  • keyword-onlyname: str | None = None

  Returns RequestQueueMetadata

update_request

• async update_request(request, *, forefront): ProcessedRequest

• Parameters

  • request: Request

  • keyword-onlyforefront: bool = False

  Returns ProcessedRequest

update_timestamps

• async update_timestamps(*, has_been_modified): None

• Update the timestamps of the request queue.

  ---

  Parameters

  • keyword-onlyhas_been_modified: bool

  Returns None

Properties

resource_directory

resource_directory: str

Get the resource directory for the client.

resource_info

resource_info: RequestQueueMetadata

Get the resource info for the request queue client.