RunCollectionListOptions

Options shared by every method that sends a request to the API.

Hierarchy

• PaginationOptions
• TimeoutOptions
  • RunCollectionListOptions

Index

Properties

• chunkSize
• desc
• limit
• offset
• signal
• startedAfter
• startedBefore
• status
• timeoutSecs

Properties

optionalinheritedchunkSize

chunkSize?: number

Inherited from PaginationOptions.chunkSize

Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator will fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the limit is reached or once all items from API have been fetched.

Chunk size is usually limited by API. Minimum of those two limits will be used.

Added in 2.21.0

optionaldesc

desc?: boolean

optionalinheritedlimit

limit?: number

Inherited from PaginationOptions.limit

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Inherited from PaginationOptions.offset

Position of the first returned entry.

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.

optionalstartedAfter

startedAfter?: string | Date

Added in 2.18.0

optionalstartedBefore

startedBefore?: string | Date

Added in 2.18.0

optionalstatus

status?: READY | RUNNING | SUCCEEDED | FAILED | ABORTING | ABORTED | TIMING-OUT | TIMED-OUT | (READY | RUNNING | SUCCEEDED | FAILED | ABORTING | ABORTED | TIMING-OUT | TIMED-OUT)[]

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.