Interface PagedListDescriptor<RequestT,ResponseT,ResourceT> (2.37.0)
Stay organized with collections Save and categorize content based on your preferences.

public interface PagedListDescriptor<RequestT,ResponseT,ResourceT>

An interface which provides the functionality to extract data from requests and inject data into requests for the purposes of page streaming.

This class is designed to be used by generated code.

Methods

public abstract String emptyToken()

Delivers the empty page token.

Returns
Type	Description
`String`

public abstract String extractNextToken(ResponseT payload)

Extracts the next token from the response. Returns the empty token if there are no more pages.

Parameter
Name	Description
`payload`	`ResponseT`

Returns
Type	Description
`String`

public abstract Integer extractPageSize(RequestT payload)

Extracts the page size setting from the request.

Parameter
Name	Description
`payload`	`RequestT`

Returns
Type	Description
`Integer`

public abstract Iterable<ResourceT> extractResources(ResponseT payload)

Extracts an iterable of resources from the response.

Parameter
Name	Description
`payload`	`ResponseT`

Returns
Type	Description
`Iterable<ResourceT>`

public abstract RequestT injectPageSize(RequestT payload, int pageSize)

Injects page size setting into the request.

Returns
Type	Description
`RequestT`

public abstract RequestT injectToken(RequestT payload, String token)

Injects a page token into the request.

Returns
Type	Description
`RequestT`