Skip to content

Allow cursor-based pagination to query extra page until collection is empty #3790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nogates merged 1 commit into from
May 5, 2026
Merged

Allow cursor-based pagination to query extra page until collection is empty #3790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .generator/src/generator/templates/Api.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ public class {{ name }} {
args.put("optionalParams", parameters);
{%- endif %}

PaginationIterable iterator = new PaginationIterable(this, "{{ operationId }}", resultsPath, valueGetterPath, valueSetterPath, valueSetterParamOptional, {% if pagination.pageParam %}false{% else %}true{% endif %}, limit, args, {{ pagination.pageStart | default(0) }});
PaginationIterable iterator = new PaginationIterable(this, "{{ operationId }}", resultsPath, valueGetterPath, valueSetterPath, valueSetterParamOptional, {% if pagination.pageParam %}false{% else %}true{% endif %}, {% if pagination.cursorParam %}true{% else %}false{% endif %}, limit, args, {{ pagination.pageStart | default(0) }});

return iterator;
{%- endmacro %}
Expand Down
3 changes: 3 additions & 0 deletions .generator/src/generator/templates/PaginationIterable.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ public class PaginationIterable<T> implements Iterable<T> {
String[] valueSetterPath;
Boolean valueSetterParamOptional;
Boolean offsetPageIncrement;
Boolean cursorPagination;
Object limit;
LinkedHashMap<String, Object> args;
int pageStart;
Expand All @@ -24,6 +25,7 @@ public class PaginationIterable<T> implements Iterable<T> {
String valueSetterPath,
Boolean valueSetterParamOptional,
Boolean offsetPageIncrement,
Boolean cursorPagination,
Object limit,
LinkedHashMap<String, Object> args,
int pageStart) {
Expand All @@ -41,6 +43,7 @@ public class PaginationIterable<T> implements Iterable<T> {
this.valueSetterPath = valueSetterPath.split("\\.");
this.valueSetterParamOptional = valueSetterParamOptional;
this.offsetPageIncrement = offsetPageIncrement;
this.cursorPagination = cursorPagination;
this.limit = limit;
this.args = args;
this.pageStart = pageStart;
Expand Down
6 changes: 5 additions & 1 deletion .generator/src/generator/templates/PaginationIterator.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,11 @@ public class PaginationIterator<T> implements Iterator<T> {
return true;
}

if (this.data.size() < convertToInt(this.iterable.limit)) {
if (this.iterable.cursorPagination) {
if (this.data.size() == 0) {
return false;
}
} else if (this.data.size() < convertToInt(this.iterable.limit)) {
return false;
}

Expand Down
3 changes: 3 additions & 0 deletions src/main/java/com/datadog/api/client/PaginationIterable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ public class PaginationIterable<T> implements Iterable<T> {
String[] valueSetterPath;
Boolean valueSetterParamOptional;
Boolean offsetPageIncrement;
Boolean cursorPagination;
Object limit;
LinkedHashMap<String, Object> args;
int pageStart;
Expand All @@ -28,6 +29,7 @@ public PaginationIterable(
String valueSetterPath,
Boolean valueSetterParamOptional,
Boolean offsetPageIncrement,
Boolean cursorPagination,
Object limit,
LinkedHashMap<String, Object> args,
int pageStart) {
Expand All @@ -45,6 +47,7 @@ public PaginationIterable(
this.valueSetterPath = valueSetterPath.split("\\.");
this.valueSetterParamOptional = valueSetterParamOptional;
this.offsetPageIncrement = offsetPageIncrement;
this.cursorPagination = cursorPagination;
this.limit = limit;
this.args = args;
this.pageStart = pageStart;
Expand Down
6 changes: 5 additions & 1 deletion src/main/java/com/datadog/api/client/PaginationIterator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,11 @@ public boolean hasNext() {
return true;
}

if (this.data.size() < convertToInt(this.iterable.limit)) {
if (this.iterable.cursorPagination) {
if (this.data.size() == 0) {
return false;
}
} else if (this.data.size() < convertToInt(this.iterable.limit)) {
return false;
}

Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v1/api/DashboardsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1543,6 +1543,7 @@ public PaginationIterable<DashboardSummaryDefinition> listDashboardsWithPaginati
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1329,6 +1329,7 @@ public PaginationIterable<Monitor> listMonitorsWithPagination(
valueSetterPath,
valueSetterParamOptional,
false,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v1/api/NotebooksApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,7 @@ public PaginationIterable<NotebooksResponseData> listNotebooksWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v1/api/ServiceLevelObjectiveCorrectionsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,7 @@ public PaginationIterable<SLOCorrection> listSLOCorrectionWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v1/api/ServiceLevelObjectivesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1445,6 +1445,7 @@ public PaginationIterable<ServiceLevelObjective> listSLOsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v1/api/SyntheticsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3654,6 +3654,7 @@ public PaginationIterable<SyntheticsTestDetailsWithoutSteps> listTestsWithPagina
valueSetterPath,
valueSetterParamOptional,
false,
false,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/AuditApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@ public PaginationIterable<AuditLogsEvent> listAuditLogsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -486,6 +487,7 @@ public PaginationIterable<AuditLogsEvent> searchAuditLogsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/BitsAiApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,6 +346,7 @@ public PaginationIterable<ListInvestigationsResponseData> listInvestigationsWith
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/CaseManagementApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3330,6 +3330,7 @@ public PaginationIterable<Case> searchCasesWithPagination(
valueSetterPath,
valueSetterParamOptional,
false,
false,
limit,
args,
1);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/CiVisibilityPipelinesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,7 @@ public PaginationIterable<CIAppPipelineEvent> listCIAppPipelineEventsWithPaginat
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -781,6 +782,7 @@ public PaginationIterable<CIAppPipelineEvent> searchCIAppPipelineEventsWithPagin
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/CiVisibilityTestsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@ public PaginationIterable<CIAppTestEvent> listCIAppTestEventsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -628,6 +629,7 @@ public PaginationIterable<CIAppTestEvent> searchCIAppTestEventsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/ContainerImagesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ public PaginationIterable<ContainerImageItem> listContainerImagesWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/ContainersApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ public PaginationIterable<ContainerItem> listContainersWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/DowntimesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -679,6 +679,7 @@ public PaginationIterable<DowntimeResponseData> listDowntimesWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down Expand Up @@ -936,6 +937,7 @@ public PaginationIterable<MonitorDowntimeMatchResponseData> listMonitorDowntimes
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/EventsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,7 @@ public PaginationIterable<EventResponse> listEventsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -768,6 +769,7 @@ public PaginationIterable<EventResponse> searchEventsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/IncidentsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7630,6 +7630,7 @@ public PaginationIterable<IncidentResponseData> listIncidentsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down Expand Up @@ -8554,6 +8555,7 @@ public PaginationIterable<IncidentSearchResponseIncidentsData> searchIncidentsWi
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/LogsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,7 @@ public PaginationIterable<Log> listLogsWithPagination(ListLogsOptionalParameters
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -621,6 +622,7 @@ public PaginationIterable<Log> listLogsGetWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/MetricsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1855,6 +1855,7 @@ public PaginationIterable<MetricsAndMetricTagConfigurations> listTagConfiguratio
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/NetworkDeviceMonitoringApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,7 @@ public PaginationIterable<DevicesListData> listDevicesWithPagination(
valueSetterPath,
valueSetterParamOptional,
false,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/PowerpackApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,7 @@ public PaginationIterable<PowerpackData> listPowerpacksWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/ProcessesApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@ public PaginationIterable<ProcessSummary> listProcessesWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/RumApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,6 +880,7 @@ public PaginationIterable<RUMEvent> listRUMEventsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -1073,6 +1074,7 @@ public PaginationIterable<RUMEvent> searchRUMEventsWithPagination(RUMSearchEvent
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
2 changes: 2 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/ScorecardsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1448,6 +1448,7 @@ public PaginationIterable<OutcomesResponseDataItem> listScorecardOutcomesWithPag
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down Expand Up @@ -1826,6 +1827,7 @@ public PaginationIterable<ListRulesResponseDataItem> listScorecardRulesWithPagin
valueSetterPath,
valueSetterParamOptional,
true,
false,
limit,
args,
0);
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/com/datadog/api/client/v2/api/SecurityMonitoringApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10610,6 +10610,7 @@ public PaginationIterable<Finding> listFindingsWithPagination(
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -12111,6 +12112,7 @@ public PaginationIterable<SecurityFindingsData> listSecurityFindingsWithPaginati
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -13045,6 +13047,7 @@ public PaginationIterable<SecurityMonitoringSignal> listSecurityMonitoringSignal
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -15936,6 +15939,7 @@ public PaginationIterable<SecurityFindingsData> searchSecurityFindingsWithPagina
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down Expand Up @@ -16384,6 +16388,7 @@ public PaginationIterable<SecurityMonitoringSignal> searchSecurityMonitoringSign
valueSetterPath,
valueSetterParamOptional,
true,
true,
limit,
args,
0);
Expand Down
1 change: 1 addition & 0 deletions src/main/java/com/datadog/api/client/v2/api/ServiceDefinitionApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,7 @@ public PaginationIterable<ServiceDefinitionData> listServiceDefinitionsWithPagin
valueSetterPath,
valueSetterParamOptional,
false,
false,
limit,
args,
0);
Expand Down
Loading
Loading