Interface PagedListDescriptor<RequestT,ResponseT,ResourceT> (2.54.1)
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.
Type Parameters |
| Name |
Description |
RequestT |
|
ResponseT |
|
ResourceT |
|
Methods
emptyToken()
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
|
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> |
|
injectPageSize(RequestT payload, int pageSize)
public abstract RequestT injectPageSize(RequestT payload, int pageSize)
Injects page size setting into the request.
| Parameters |
| Name |
Description |
payload |
RequestT
|
pageSize |
int
|
| Returns |
| Type |
Description |
RequestT |
|
injectToken(RequestT payload, String token)
public abstract RequestT injectToken(RequestT payload, String token)
Injects a page token into the request.
| Parameters |
| Name |
Description |
payload |
RequestT
|
token |
String
|
| Returns |
| Type |
Description |
RequestT |
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-03 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-10-03 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-03 UTC."]]
