RequestQueueClientPaginateRequestsOptions

Options for paginating through requests in the queue.

Hierarchy

• TimeoutOptions
  • RequestQueueClientPaginateRequestsOptions

Added in 2.5.1

Index

Properties

• cursor
• filter
• limit
• maxPageLimit
• signal
• timeoutSecs

Properties

optionalcursor

cursor?: string

Added in 2.23.2

optionalfilter

filter?: readonly RequestQueueListRequestsFilter[]

Added in 2.23.2

optionallimit

limit?: number

optionalmaxPageLimit

maxPageLimit?: 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.