Class FileListParams.Builder
-
- All Implemented Interfaces:
public final class FileListParams.Builder
A builder for FileListParams.
-
-
Method Summary
-
-
Method Detail
-
after
final FileListParams.Builder after(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.
-
after
final FileListParams.Builder after(Optional<String> after)
Alias for calling Builder.after with
after.orElse(null)
.
-
limit
final FileListParams.Builder limit(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.
-
limit
final FileListParams.Builder limit(Long limit)
Alias for Builder.limit.
This unboxed primitive overload exists for backwards compatibility.
-
limit
final FileListParams.Builder limit(Optional<Long> limit)
Alias for calling Builder.limit with
limit.orElse(null)
.
-
order
final FileListParams.Builder order(FileListParams.Order order)
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
order
final FileListParams.Builder order(Optional<FileListParams.Order> order)
Alias for calling Builder.order with
order.orElse(null)
.
-
purpose
final FileListParams.Builder purpose(String purpose)
Only return files with the given purpose.
-
purpose
final FileListParams.Builder purpose(Optional<String> purpose)
Alias for calling Builder.purpose with
purpose.orElse(null)
.
-
additionalHeaders
final FileListParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final FileListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final FileListParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final FileListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final FileListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final FileListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final FileListParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final FileListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final FileListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final FileListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final FileListParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final FileListParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final FileListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final FileListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final FileListParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final FileListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final FileListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final FileListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final FileListParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final FileListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final FileListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final FileListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final FileListParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final FileListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final FileListParams build()
Returns an immutable instance of FileListParams.
Further updates to this Builder will not mutate the returned instance.
-
-
-
-