com.oracle.bmc.generativeai.GenerativeAiPaginators Maven / Gradle / Ivy
Show all versions of oci-java-sdk-generativeai 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.generativeai;
import com.oracle.bmc.generativeai.requests.*;
import com.oracle.bmc.generativeai.responses.*;
/**
* Collection of helper methods that can be used to provide an {@link java.lang.Iterable} interface
* to any list operations of GenerativeAi 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: 20231130")
public class GenerativeAiPaginators {
private final GenerativeAi client;
public GenerativeAiPaginators(GenerativeAi client) {
this.client = client;
}
/**
* Creates a new iterable which will iterate over the responses received from the
* listDedicatedAiClusters 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 listDedicatedAiClustersResponseIterator(
final ListDedicatedAiClustersRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListDedicatedAiClustersRequest.Builder,
ListDedicatedAiClustersRequest,
ListDedicatedAiClustersResponse>(
new java.util.function.Supplier() {
@Override
public ListDedicatedAiClustersRequest.Builder get() {
return ListDedicatedAiClustersRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListDedicatedAiClustersResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDedicatedAiClustersRequest.Builder>,
ListDedicatedAiClustersRequest>() {
@Override
public ListDedicatedAiClustersRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDedicatedAiClustersRequest.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<
ListDedicatedAiClustersRequest, ListDedicatedAiClustersResponse>() {
@Override
public ListDedicatedAiClustersResponse apply(
ListDedicatedAiClustersRequest request) {
return client.listDedicatedAiClusters(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.generativeai.model.DedicatedAiClusterSummary} objects contained in responses
* from the listDedicatedAiClusters 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.generativeai.model.DedicatedAiClusterSummary} objects contained in
* responses received from the service.
*/
public Iterable
listDedicatedAiClustersRecordIterator(final ListDedicatedAiClustersRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListDedicatedAiClustersRequest.Builder,
ListDedicatedAiClustersRequest,
ListDedicatedAiClustersResponse,
com.oracle.bmc.generativeai.model.DedicatedAiClusterSummary>(
new java.util.function.Supplier() {
@Override
public ListDedicatedAiClustersRequest.Builder get() {
return ListDedicatedAiClustersRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListDedicatedAiClustersResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDedicatedAiClustersRequest.Builder>,
ListDedicatedAiClustersRequest>() {
@Override
public ListDedicatedAiClustersRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListDedicatedAiClustersRequest.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<
ListDedicatedAiClustersRequest, ListDedicatedAiClustersResponse>() {
@Override
public ListDedicatedAiClustersResponse apply(
ListDedicatedAiClustersRequest request) {
return client.listDedicatedAiClusters(request);
}
},
new java.util.function.Function<
ListDedicatedAiClustersResponse,
java.util.List<
com.oracle.bmc.generativeai.model.DedicatedAiClusterSummary>>() {
@Override
public java.util.List<
com.oracle.bmc.generativeai.model.DedicatedAiClusterSummary>
apply(ListDedicatedAiClustersResponse response) {
return response.getDedicatedAiClusterCollection().getItems();
}
});
}
/**
* Creates a new iterable which will iterate over the responses received from the listEndpoints
* 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 listEndpointsResponseIterator(
final ListEndpointsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListEndpointsRequest.Builder, ListEndpointsRequest, ListEndpointsResponse>(
new java.util.function.Supplier() {
@Override
public ListEndpointsRequest.Builder get() {
return ListEndpointsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListEndpointsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListEndpointsRequest.Builder>,
ListEndpointsRequest>() {
@Override
public ListEndpointsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListEndpointsRequest.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 ListEndpointsResponse apply(ListEndpointsRequest request) {
return client.listEndpoints(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.generativeai.model.EndpointSummary} objects contained in responses from the
* listEndpoints 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.generativeai.model.EndpointSummary} objects contained in responses
* received from the service.
*/
public Iterable listEndpointsRecordIterator(
final ListEndpointsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListEndpointsRequest.Builder,
ListEndpointsRequest,
ListEndpointsResponse,
com.oracle.bmc.generativeai.model.EndpointSummary>(
new java.util.function.Supplier() {
@Override
public ListEndpointsRequest.Builder get() {
return ListEndpointsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListEndpointsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListEndpointsRequest.Builder>,
ListEndpointsRequest>() {
@Override
public ListEndpointsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListEndpointsRequest.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 ListEndpointsResponse apply(ListEndpointsRequest request) {
return client.listEndpoints(request);
}
},
new java.util.function.Function<
ListEndpointsResponse,
java.util.List>() {
@Override
public java.util.List apply(
ListEndpointsResponse response) {
return response.getEndpointCollection().getItems();
}
});
}
/**
* Creates a new iterable which will iterate over the responses received from the listModels
* 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 listModelsResponseIterator(
final ListModelsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListModelsRequest.Builder, ListModelsRequest, ListModelsResponse>(
new java.util.function.Supplier() {
@Override
public ListModelsRequest.Builder get() {
return ListModelsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListModelsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListModelsRequest.Builder>,
ListModelsRequest>() {
@Override
public ListModelsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListModelsRequest.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 ListModelsResponse apply(ListModelsRequest request) {
return client.listModels(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.generativeai.model.ModelSummary} objects contained in responses from the
* listModels 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.generativeai.model.ModelSummary} objects contained in responses received
* from the service.
*/
public Iterable listModelsRecordIterator(
final ListModelsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListModelsRequest.Builder,
ListModelsRequest,
ListModelsResponse,
com.oracle.bmc.generativeai.model.ModelSummary>(
new java.util.function.Supplier() {
@Override
public ListModelsRequest.Builder get() {
return ListModelsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListModelsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListModelsRequest.Builder>,
ListModelsRequest>() {
@Override
public ListModelsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListModelsRequest.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 ListModelsResponse apply(ListModelsRequest request) {
return client.listModels(request);
}
},
new java.util.function.Function<
ListModelsResponse,
java.util.List>() {
@Override
public java.util.List apply(
ListModelsResponse response) {
return response.getModelCollection().getItems();
}
});
}
/**
* Creates a new iterable which will iterate over the responses received from the
* listWorkRequestErrors 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 listWorkRequestErrorsResponseIterator(
final ListWorkRequestErrorsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListWorkRequestErrorsRequest.Builder,
ListWorkRequestErrorsRequest,
ListWorkRequestErrorsResponse>(
new java.util.function.Supplier() {
@Override
public ListWorkRequestErrorsRequest.Builder get() {
return ListWorkRequestErrorsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListWorkRequestErrorsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestErrorsRequest.Builder>,
ListWorkRequestErrorsRequest>() {
@Override
public ListWorkRequestErrorsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestErrorsRequest.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<
ListWorkRequestErrorsRequest, ListWorkRequestErrorsResponse>() {
@Override
public ListWorkRequestErrorsResponse apply(
ListWorkRequestErrorsRequest request) {
return client.listWorkRequestErrors(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.generativeai.model.WorkRequestError} objects contained in responses from the
* listWorkRequestErrors 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.generativeai.model.WorkRequestError} objects contained in responses
* received from the service.
*/
public Iterable
listWorkRequestErrorsRecordIterator(final ListWorkRequestErrorsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListWorkRequestErrorsRequest.Builder,
ListWorkRequestErrorsRequest,
ListWorkRequestErrorsResponse,
com.oracle.bmc.generativeai.model.WorkRequestError>(
new java.util.function.Supplier() {
@Override
public ListWorkRequestErrorsRequest.Builder get() {
return ListWorkRequestErrorsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListWorkRequestErrorsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestErrorsRequest.Builder>,
ListWorkRequestErrorsRequest>() {
@Override
public ListWorkRequestErrorsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestErrorsRequest.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<
ListWorkRequestErrorsRequest, ListWorkRequestErrorsResponse>() {
@Override
public ListWorkRequestErrorsResponse apply(
ListWorkRequestErrorsRequest request) {
return client.listWorkRequestErrors(request);
}
},
new java.util.function.Function<
ListWorkRequestErrorsResponse,
java.util.List>() {
@Override
public java.util.List apply(
ListWorkRequestErrorsResponse response) {
return response.getWorkRequestErrorCollection().getItems();
}
});
}
/**
* Creates a new iterable which will iterate over the responses received from the
* listWorkRequestLogs 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 listWorkRequestLogsResponseIterator(
final ListWorkRequestLogsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListWorkRequestLogsRequest.Builder,
ListWorkRequestLogsRequest,
ListWorkRequestLogsResponse>(
new java.util.function.Supplier() {
@Override
public ListWorkRequestLogsRequest.Builder get() {
return ListWorkRequestLogsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListWorkRequestLogsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestLogsRequest.Builder>,
ListWorkRequestLogsRequest>() {
@Override
public ListWorkRequestLogsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestLogsRequest.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<
ListWorkRequestLogsRequest, ListWorkRequestLogsResponse>() {
@Override
public ListWorkRequestLogsResponse apply(ListWorkRequestLogsRequest request) {
return client.listWorkRequestLogs(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.generativeai.model.WorkRequestLogEntry} objects contained in responses from
* the listWorkRequestLogs 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.generativeai.model.WorkRequestLogEntry} objects contained in responses
* received from the service.
*/
public Iterable
listWorkRequestLogsRecordIterator(final ListWorkRequestLogsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListWorkRequestLogsRequest.Builder,
ListWorkRequestLogsRequest,
ListWorkRequestLogsResponse,
com.oracle.bmc.generativeai.model.WorkRequestLogEntry>(
new java.util.function.Supplier() {
@Override
public ListWorkRequestLogsRequest.Builder get() {
return ListWorkRequestLogsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListWorkRequestLogsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestLogsRequest.Builder>,
ListWorkRequestLogsRequest>() {
@Override
public ListWorkRequestLogsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestLogsRequest.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<
ListWorkRequestLogsRequest, ListWorkRequestLogsResponse>() {
@Override
public ListWorkRequestLogsResponse apply(ListWorkRequestLogsRequest request) {
return client.listWorkRequestLogs(request);
}
},
new java.util.function.Function<
ListWorkRequestLogsResponse,
java.util.List>() {
@Override
public java.util.List
apply(ListWorkRequestLogsResponse response) {
return response.getWorkRequestLogEntryCollection().getItems();
}
});
}
/**
* Creates a new iterable which will iterate over the responses received from the
* listWorkRequests 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 listWorkRequestsResponseIterator(
final ListWorkRequestsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseIterable<
ListWorkRequestsRequest.Builder, ListWorkRequestsRequest, ListWorkRequestsResponse>(
new java.util.function.Supplier() {
@Override
public ListWorkRequestsRequest.Builder get() {
return ListWorkRequestsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListWorkRequestsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestsRequest.Builder>,
ListWorkRequestsRequest>() {
@Override
public ListWorkRequestsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestsRequest.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<
ListWorkRequestsRequest, ListWorkRequestsResponse>() {
@Override
public ListWorkRequestsResponse apply(ListWorkRequestsRequest request) {
return client.listWorkRequests(request);
}
});
}
/**
* Creates a new iterable which will iterate over the {@link
* com.oracle.bmc.generativeai.model.WorkRequestSummary} objects contained in responses from the
* listWorkRequests 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.generativeai.model.WorkRequestSummary} objects contained in responses
* received from the service.
*/
public Iterable
listWorkRequestsRecordIterator(final ListWorkRequestsRequest request) {
return new com.oracle.bmc.paginator.internal.ResponseRecordIterable<
ListWorkRequestsRequest.Builder,
ListWorkRequestsRequest,
ListWorkRequestsResponse,
com.oracle.bmc.generativeai.model.WorkRequestSummary>(
new java.util.function.Supplier() {
@Override
public ListWorkRequestsRequest.Builder get() {
return ListWorkRequestsRequest.builder().copy(request);
}
},
new java.util.function.Function() {
@Override
public String apply(ListWorkRequestsResponse response) {
return response.getOpcNextPage();
}
},
new java.util.function.Function<
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestsRequest.Builder>,
ListWorkRequestsRequest>() {
@Override
public ListWorkRequestsRequest apply(
com.oracle.bmc.paginator.internal.RequestBuilderAndToken<
ListWorkRequestsRequest.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<
ListWorkRequestsRequest, ListWorkRequestsResponse>() {
@Override
public ListWorkRequestsResponse apply(ListWorkRequestsRequest request) {
return client.listWorkRequests(request);
}
},
new java.util.function.Function<
ListWorkRequestsResponse,
java.util.List>() {
@Override
public java.util.List
apply(ListWorkRequestsResponse response) {
return response.getWorkRequestSummaryCollection().getItems();
}
});
}
}