Class FileListParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class FileListParams implements Params
Returns a list of files.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
FileListParams.Builder
A builder for FileListParams.
public final class
FileListParams.Order
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
Method Summary
Modifier and Type Method Description final Optional<String>
after()
A cursor for use in pagination. final Optional<Long>
limit()
A limit on the number of objects to be returned. final Optional<FileListParams.Order>
order()
Sort order by the created_at
timestamp of the objects.final Optional<String>
purpose()
Only return files with the given purpose. final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final FileListParams.Builder
toBuilder()
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static FileListParams
none()
final static FileListParams.Builder
builder()
Returns a mutable builder for constructing an instance of FileListParams. -
-
Method Detail
-
after
final Optional<String> after()
A cursor for use in pagination.
after
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
-
limit
final Optional<Long> limit()
A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.
-
order
final Optional<FileListParams.Order> order()
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final FileListParams.Builder toBuilder()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static FileListParams none()
-
builder
final static FileListParams.Builder builder()
Returns a mutable builder for constructing an instance of FileListParams.
-
-
-
-