All Implemented Interfaces:: com.openai.core.Params


public final class FileBatchListFilesParams
 implements Params

Returns a list of vector store files in a batch.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`FileBatchListFilesParams.Builder`	A builder for FileBatchListFilesParams.
`public final class`	`FileBatchListFilesParams.Filter`	Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
`public final class`	`FileBatchListFilesParams.Order`	Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`vectorStoreId()`
`final Optional<String>`	`batchId()`
`final Optional<String>`	`after()`	A cursor for use in pagination.
`final Optional<String>`	`before()`	A cursor for use in pagination.
`final Optional<FileBatchListFilesParams.Filter>`	`filter()`	Filter by file status.
`final Optional<Long>`	`limit()`	A limit on the number of objects to be returned.
`final Optional<FileBatchListFilesParams.Order>`	`order()`	Sort order by the `created_at` timestamp of the objects.
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final FileBatchListFilesParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`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 FileBatchListFilesParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of FileBatchListFilesParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - vectorStoreId
```
 final String vectorStoreId()
```
  - batchId
```
 final Optional<String> batchId()
```
  - 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.
  - before
```
 final Optional<String> before()
```
    A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
  - filter
```
 final Optional<FileBatchListFilesParams.Filter> filter()
```
    Filter by file status. One of in_progress, completed, failed, cancelled.
  - limit
```
 final Optional<Long> limit()
```
    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
  - order
```
 final Optional<FileBatchListFilesParams.Order> order()
```
    Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final FileBatchListFilesParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _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.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static FileBatchListFilesParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of FileBatchListFilesParams.
    The following fields are required:
    .vectorStoreId()

Class FileBatchListFilesParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

vectorStoreId

batchId

after

before

filter

limit

order

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder