- 2.70.0 (latest)
- 2.69.0
- 2.68.2
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.1
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.1
- 2.58.0
- 2.57.0
- 2.55.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.1
- 2.47.0
- 2.46.1
- 2.45.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.1
- 2.33.0
- 2.32.1
- 2.31.1
- 2.30.1
- 2.24.0
- 2.23.3
- 2.22.0
- 2.21.0
- 2.20.1
- 2.19.6
- 2.18.7
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.1
- 2.7.1
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.
Type Parameters
Name
Description
RequestT
ResponseT
ResourceT
Methods
emptyToken()
public
abstract
String
emptyToken
()
Delivers the empty page token.
extractNextToken(ResponseT payload)
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
extractPageSize(RequestT payload)
public
abstract
Integer
extractPageSize
(
RequestT
payload
)
Extracts the page size setting from the request.
Parameter
Name
Description
payload
RequestT
extractResources(ResponseT payload)
public
abstract
Iterable<ResourceT>
extractResources
(
ResponseT
payload
)
Extracts an iterable of resources from the response.
Parameter
Name
Description
payload
ResponseT
injectPageSize(RequestT payload, int pageSize)
public
abstract
RequestT
injectPageSize
(
RequestT
payload
,
int
pageSize
)
Injects page size setting into the request.
Returns
Type
Description
RequestT
injectToken(RequestT payload, String token)
public
abstract
RequestT
injectToken
(
RequestT
payload
,
String
token
)
Injects a page token into the request.
Returns
Type
Description
RequestT
