com.oracle.bmc.dashboardservice.DashboardPaginators Maven / Gradle / Ivy
Show all versions of oci-java-sdk-dashboardservice Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.dashboardservice;
import com.oracle.bmc.dashboardservice.requests.*;
import com.oracle.bmc.dashboardservice.responses.*;
/**
* Collection of helper methods that can be used to provide an {@link java.lang.Iterable} interface
* to any list operations of Dashboard where multiple pages of data may be fetched. Two styles of
* iteration are supported:
*
*
* - Iterating over the Response objects returned by the list operation. These are referred to
* as ResponseIterators, and the methods are suffixed with ResponseIterator. For example:
* listUsersResponseIterator
*
- Iterating over the resources/records being listed. These are referred to as
* RecordIterators, and the methods are suffixed with RecordIterator. For example:
* listUsersRecordIterator
*
*
* These iterables abstract away the need to write code to manually handle pagination via looping
* and using the page tokens. They will automatically fetch more data from the service when
* required.
*
* As an example, if we were using the ListUsers operation in IdentityService, then the {@link
* java.lang.Iterable} returned by calling a ResponseIterator method would iterate over the
* ListUsersResponse objects returned by each ListUsers call, whereas the {@link java.lang.Iterable}
* returned by calling a RecordIterator method would iterate over the User records and we don't have
* to deal with ListUsersResponse objects at all. In either case, pagination will be automatically
* handled so we can iterate until there are no more responses or no more resources/records
* available.
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20210731")
public class DashboardPaginators {
private final Dashboard client;
public DashboardPaginators(Dashboard client) {
this.client = client;
}
/**
* Creates a new iterable which will iterate over the responses received from the listDashboards
* operation. This iterable will fetch more data from the server as needed.
*
* @param request a request which can be sent to the service operation
* @return an {@link java.lang.Iterable} which can be used to iterate over the responses
* received from the service.
*/
public Iterable listDashboardsResponseIterator(
final ListDashboardsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListDashboardsRequest.Builder, ListDashboardsRequest, ListDashboardsResponse>(
new java.util.function.Supplier() {
@Override
public ListDashboardsRequest.Builder get() {
return ListDashboardsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListDashboardsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDashboardsRequest.Builder>,
ListDashboardsRequest>() {
@Override
public ListDashboardsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDashboardsRequest.Builder>
input) {
if (input.getNextPageToken() == null) {
return input.getRequestBuilder().build();
} else {
return input.getRequestBuilder()
.page(input.getNextPageToken().orElse(null))
.build();
}
}
},
new java.util.function.Function() {
@Override
public ListDashboardsResponse apply(ListDashboardsRequest request) {
return client.listDashboards(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.dashboardservice.model.DashboardSummary} objects contained in responses from
* the listDashboards operation. This iterable will fetch more data from the server as needed.
*
* @param request a request which can be sent to the service operation
* @return an {@link java.lang.Iterable} which can be used to iterate over the {@link
* com.oracle.bmc.dashboardservice.model.DashboardSummary} objects contained in responses
* received from the service.
*/
public Iterable
listDashboardsRecordIterator(final ListDashboardsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListDashboardsRequest.Builder,
ListDashboardsRequest,
ListDashboardsResponse,
com.oracle.bmc.dashboardservice.model.DashboardSummary>(
new java.util.function.Supplier() {
@Override
public ListDashboardsRequest.Builder get() {
return ListDashboardsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListDashboardsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDashboardsRequest.Builder>,
ListDashboardsRequest>() {
@Override
public ListDashboardsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDashboardsRequest.Builder>
input) {
if (input.getNextPageToken() == null) {
return input.getRequestBuilder().build();
} else {
return input.getRequestBuilder()
.page(input.getNextPageToken().orElse(null))
.build();
}
}
},
new java.util.function.Function() {
@Override
public ListDashboardsResponse apply(ListDashboardsRequest request) {
return client.listDashboards(request);
}
},
new java.util.function.Function<
ListDashboardsResponse,
java.util.List>() {
@Override
public java.util.List
apply(ListDashboardsResponse response) {
return response.getDashboardCollection().getItems();
}
});
}
}