RequestQueueClientListRequestsOptions

Options for listing all requests in the queue.

Hierarchy

• TimeoutOptions
  • RequestQueueClientListRequestsOptions

Added in 2.5.1

Index

Properties

• chunkSize
• cursor
• filter
• limit
• signal
• timeoutSecs

Properties

optionalchunkSize

chunkSize?: number

Maximum number of requests returned in one API response. When the call is iterated with for await, the iterator fetches requests in chunks of this size and yields them one by one, until limit is reached or the RQ is exhausted. Awaiting the call returns only the first chunk.

optionalcursor

cursor?: string

Added in 2.23.2

optionalfilter

filter?: readonly RequestQueueListRequestsFilter[]

Added in 2.23.2

optionallimit

limit?: number

optionalinheritedsignal

signal?: AbortSignal

Inherited from TimeoutOptions.signal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Inherited from TimeoutOptions.timeoutSecs

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.