Class InputItemListParams.Builder
-
- All Implemented Interfaces:
public final class InputItemListParams.Builder
A builder for InputItemListParams.
-
-
Method Summary
-
-
Method Detail
-
responseId
final InputItemListParams.Builder responseId(String responseId)
-
after
final InputItemListParams.Builder after(String after)
An item ID to list items after, used in pagination.
-
after
final InputItemListParams.Builder after(Optional<String> after)
Alias for calling Builder.after with
after.orElse(null)
.
-
before
final InputItemListParams.Builder before(String before)
An item ID to list items before, used in pagination.
-
before
final InputItemListParams.Builder before(Optional<String> before)
Alias for calling Builder.before with
before.orElse(null)
.
-
include
final InputItemListParams.Builder include(List<ResponseIncludable> include)
Additional fields to include in the response. See the
include
parameter for Response creation above for more information.
-
include
final InputItemListParams.Builder include(Optional<List<ResponseIncludable>> include)
Alias for calling Builder.include with
include.orElse(null)
.
-
addInclude
final InputItemListParams.Builder addInclude(ResponseIncludable include)
Adds a single ResponseIncludable to Builder.include.
-
limit
final InputItemListParams.Builder limit(Long limit)
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
-
limit
final InputItemListParams.Builder limit(Long limit)
Alias for Builder.limit.
This unboxed primitive overload exists for backwards compatibility.
-
limit
final InputItemListParams.Builder limit(Optional<Long> limit)
Alias for calling Builder.limit with
limit.orElse(null)
.
-
order
final InputItemListParams.Builder order(InputItemListParams.Order order)
The order to return the input items in. Default is
asc
.asc
: Return the input items in ascending order.desc
: Return the input items in descending order.
-
order
final InputItemListParams.Builder order(Optional<InputItemListParams.Order> order)
Alias for calling Builder.order with
order.orElse(null)
.
-
additionalHeaders
final InputItemListParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final InputItemListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final InputItemListParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final InputItemListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final InputItemListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final InputItemListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final InputItemListParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final InputItemListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final InputItemListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final InputItemListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final InputItemListParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final InputItemListParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final InputItemListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final InputItemListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final InputItemListParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final InputItemListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final InputItemListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final InputItemListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final InputItemListParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final InputItemListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final InputItemListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final InputItemListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final InputItemListParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final InputItemListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final InputItemListParams build()
Returns an immutable instance of InputItemListParams.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.responseId()
-
-
-
-