Version: Next

DatasetClientCreateItemsUrlOptions

Options for creating a public URL to access dataset items.

Extends DatasetClientListItemOptions with output format and URL expiration control, minus chunkSize (it only sizes a client-side iteration) and signature (this method produces one).

Hierarchy

Omit<DatasetClientListItemOptions, chunkSize | signature>
- DatasetClientCreateItemsUrlOptions

Added in 2.16.0

Index

Properties

optionalinheritedclean

clean?: boolean

optionalinheriteddesc

desc?: boolean

optionalexpiresInSecs

expiresInSecs?: number

optionalinheritedfields

fields?: string[]

optionalinheritedflatten

flatten?: string[]

Added in 2.6.1

optionalformat

format?: json | jsonl | xml | html | csv | xlsx | rss

Format of the items served by the URL. Defaults to json.

Added in 2.26.0

optionalinheritedlimit

limit?: number

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Position of the first returned entry.

optionalinheritedomit

omit?: string[]

optionalinheritedsignal

signal?: AbortSignal

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.

optionalinheritedskipEmpty

skipEmpty?: boolean

optionalinheritedskipHidden

skipHidden?: boolean

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

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.

optionalinheritedunwind

unwind?: string[]

optionalinheritedview

view?: string

Added in 2.2.0