Constructor Detail

Method Detail

• category

   final DocumentListParams.Builder category(DocumentListParams.Category category)

• category

   final DocumentListParams.Builder category(Optional<DocumentListParams.Category> category)

  Alias for calling Builder.category with category.orElse(null).

• createdAt

   final DocumentListParams.Builder createdAt(DocumentListParams.CreatedAt createdAt)

• createdAt

   final DocumentListParams.Builder createdAt(Optional<DocumentListParams.CreatedAt> createdAt)

  Alias for calling Builder.createdAt with createdAt.orElse(null).

• cursor

   final DocumentListParams.Builder cursor(String cursor)

  Return the page of entries after this one.

• cursor

   final DocumentListParams.Builder cursor(Optional<String> cursor)

  Alias for calling Builder.cursor with cursor.orElse(null).

• entityId

   final DocumentListParams.Builder entityId(String entityId)

  Filter Documents to ones belonging to the specified Entity.

• entityId

   final DocumentListParams.Builder entityId(Optional<String> entityId)

  Alias for calling Builder.entityId with entityId.orElse(null).

• idempotencyKey

   final DocumentListParams.Builder idempotencyKey(String idempotencyKey)

  Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

• idempotencyKey

   final DocumentListParams.Builder idempotencyKey(Optional<String> idempotencyKey)

  Alias for calling Builder.idempotencyKey with idempotencyKey.orElse(null).

• limit

   final DocumentListParams.Builder limit(Long limit)

  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

• limit

   final DocumentListParams.Builder limit(Long limit)

  Alias for Builder.limit.

  This unboxed primitive overload exists for backwards compatibility.

• limit

   final DocumentListParams.Builder limit(Optional<Long> limit)

  Alias for calling Builder.limit with limit.orElse(null).

• additionalHeaders

   final DocumentListParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final DocumentListParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final DocumentListParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final DocumentListParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final DocumentListParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final DocumentListParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final DocumentListParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final DocumentListParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final DocumentListParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final DocumentListParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final DocumentListParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final DocumentListParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final DocumentListParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final DocumentListParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final DocumentListParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final DocumentListParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final DocumentListParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final DocumentListParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final DocumentListParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final DocumentListParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final DocumentListParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final DocumentListParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final DocumentListParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final DocumentListParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final DocumentListParams build()

  Returns an immutable instance of DocumentListParams.

  Further updates to this Builder will not mutate the returned instance.