com.oracle.bmc.tenantmanagercontrolplane.DomainGovernancePaginators Maven / Gradle / Ivy
/**
* 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.tenantmanagercontrolplane;
import com.oracle.bmc.tenantmanagercontrolplane.requests.*;
import com.oracle.bmc.tenantmanagercontrolplane.responses.*;
/**
* Collection of helper methods that can be used to provide an {@link java.lang.Iterable} interface
* to any list operations of DomainGovernance 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: 20230401")
public class DomainGovernancePaginators {
private final DomainGovernance client;
public DomainGovernancePaginators(DomainGovernance client) {
this.client = client;
}
/**
* Creates a new iterable which will iterate over the responses received from the
* listDomainGovernances 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 listDomainGovernancesResponseIterator(
final ListDomainGovernancesRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListDomainGovernancesRequest.Builder,
ListDomainGovernancesRequest,
ListDomainGovernancesResponse>(
new java.util.function.Supplier() {
@Override
public ListDomainGovernancesRequest.Builder get() {
return ListDomainGovernancesRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListDomainGovernancesResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDomainGovernancesRequest.Builder>,
ListDomainGovernancesRequest>() {
@Override
public ListDomainGovernancesRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDomainGovernancesRequest.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<
ListDomainGovernancesRequest, ListDomainGovernancesResponse>() {
@Override
public ListDomainGovernancesResponse apply(
ListDomainGovernancesRequest request) {
return client.listDomainGovernances(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.tenantmanagercontrolplane.model.DomainGovernanceSummary} objects contained in
* responses from the listDomainGovernances 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.tenantmanagercontrolplane.model.DomainGovernanceSummary} objects contained
* in responses received from the service.
*/
public Iterable
listDomainGovernancesRecordIterator(final ListDomainGovernancesRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListDomainGovernancesRequest.Builder,
ListDomainGovernancesRequest,
ListDomainGovernancesResponse,
com.oracle.bmc.tenantmanagercontrolplane.model.DomainGovernanceSummary>(
new java.util.function.Supplier() {
@Override
public ListDomainGovernancesRequest.Builder get() {
return ListDomainGovernancesRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListDomainGovernancesResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDomainGovernancesRequest.Builder>,
ListDomainGovernancesRequest>() {
@Override
public ListDomainGovernancesRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDomainGovernancesRequest.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<
ListDomainGovernancesRequest, ListDomainGovernancesResponse>() {
@Override
public ListDomainGovernancesResponse apply(
ListDomainGovernancesRequest request) {
return client.listDomainGovernances(request);
}
},
new java.util.function.Function<
ListDomainGovernancesResponse,
java.util.List<
com.oracle.bmc.tenantmanagercontrolplane.model
.DomainGovernanceSummary>>() {
@Override
public java.util.List<
com.oracle.bmc.tenantmanagercontrolplane.model
.DomainGovernanceSummary>
apply(ListDomainGovernancesResponse response) {
return response.getDomainGovernanceCollection().getItems();
}
});
}
}