All Implemented Interfaces:

app.knock.api.core.Params
```
public final class ObjectListParams
 implements Params
                    
```
Returns a paginated list of objects from the specified collection. Optionally includes preference data for the objects.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ObjectListParams.Builder`	A builder for ObjectListParams.
`public final class`	`ObjectListParams.Include`

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 Optional<String>`	`collection()`
`final Optional<String>`	`after()`	The cursor to fetch entries after.
`final Optional<String>`	`before()`	The cursor to fetch entries before.
`final Optional<List<ObjectListParams.Include>>`	`include()`	Includes preferences of the objects in the response.
`final Optional<Long>`	`pageSize()`	The number of items per page.
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ObjectListParams.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 ObjectListParams`	`none()`
`final static ObjectListParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ObjectListParams.

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

Constructor Detail

Method Detail

collection
```
 final Optional<String> collection()
```

after
```
 final Optional<String> after()
```
The cursor to fetch entries after.

before
```
 final Optional<String> before()
```
The cursor to fetch entries before.

include

 final Optional<List<ObjectListParams.Include>> include()

Includes preferences of the objects in the response.

pageSize
```
 final Optional<Long> pageSize()
```
The number of items per page.

_additionalHeaders
```
 final Headers _additionalHeaders()
```

_additionalQueryParams

 final QueryParams _additionalQueryParams()

toBuilder

 final ObjectListParams.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()
```

none
```
 final static ObjectListParams none()
```

builder
```
 final static ObjectListParams.Builder builder()
```
Returns a mutable builder for constructing an instance of ObjectListParams.

Class ObjectListParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

collection

after

before

include

pageSize

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder