java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.generativeai.GenerativeAiAsyncClient

All Implemented Interfaces:

GenerativeAiAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public class GenerativeAiAsyncClient
extends BaseAsyncClient
implements GenerativeAiAsync
```
Async client implementation for GenerativeAi service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GenerativeAiAsyncClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for GenerativeAi.

Constructor Summary

Constructors
Constructor	Description
`GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`GenerativeAiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`GenerativeAiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GenerativeAiAsyncClient.Builder`	`builder()`	Create a builder for this client.
`Future<ChangeDedicatedAiClusterCompartmentResponse>`	`changeDedicatedAiClusterCompartment(ChangeDedicatedAiClusterCompartmentRequest request, AsyncHandler<ChangeDedicatedAiClusterCompartmentRequest,ChangeDedicatedAiClusterCompartmentResponse> handler)`	Moves a dedicated AI cluster into a different compartment within the same tenancy.
`Future<ChangeEndpointCompartmentResponse>`	`changeEndpointCompartment(ChangeEndpointCompartmentRequest request, AsyncHandler<ChangeEndpointCompartmentRequest,ChangeEndpointCompartmentResponse> handler)`	Moves an endpoint into a different compartment within the same tenancy.
`Future<ChangeGenerativeAiPrivateEndpointCompartmentResponse>`	`changeGenerativeAiPrivateEndpointCompartment(ChangeGenerativeAiPrivateEndpointCompartmentRequest request, AsyncHandler<ChangeGenerativeAiPrivateEndpointCompartmentRequest,ChangeGenerativeAiPrivateEndpointCompartmentResponse> handler)`	Moves a Generative AI private endpoint into a different compartment.
`Future<ChangeModelCompartmentResponse>`	`changeModelCompartment(ChangeModelCompartmentRequest request, AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)`	Moves a custom model into a different compartment.
`protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>`	`clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)`
`void`	`close()`
`Future<CreateDedicatedAiClusterResponse>`	`createDedicatedAiCluster(CreateDedicatedAiClusterRequest request, AsyncHandler<CreateDedicatedAiClusterRequest,CreateDedicatedAiClusterResponse> handler)`	Creates a dedicated AI cluster.
`Future<CreateEndpointResponse>`	`createEndpoint(CreateEndpointRequest request, AsyncHandler<CreateEndpointRequest,CreateEndpointResponse> handler)`	Creates an endpoint.
`Future<CreateGenerativeAiPrivateEndpointResponse>`	`createGenerativeAiPrivateEndpoint(CreateGenerativeAiPrivateEndpointRequest request, AsyncHandler<CreateGenerativeAiPrivateEndpointRequest,CreateGenerativeAiPrivateEndpointResponse> handler)`	Creates a Generative AI private endpoint.
`Future<CreateModelResponse>`	`createModel(CreateModelRequest request, AsyncHandler<CreateModelRequest,CreateModelResponse> handler)`	Creates a custom model by fine-tuning a base model with your own dataset.
`Future<DeleteDedicatedAiClusterResponse>`	`deleteDedicatedAiCluster(DeleteDedicatedAiClusterRequest request, AsyncHandler<DeleteDedicatedAiClusterRequest,DeleteDedicatedAiClusterResponse> handler)`	Deletes a dedicated AI cluster.
`Future<DeleteEndpointResponse>`	`deleteEndpoint(DeleteEndpointRequest request, AsyncHandler<DeleteEndpointRequest,DeleteEndpointResponse> handler)`	Deletes an endpoint.
`Future<DeleteGenerativeAiPrivateEndpointResponse>`	`deleteGenerativeAiPrivateEndpoint(DeleteGenerativeAiPrivateEndpointRequest request, AsyncHandler<DeleteGenerativeAiPrivateEndpointRequest,DeleteGenerativeAiPrivateEndpointResponse> handler)`	Deletes a Generative AI private endpoint using `privateEndpointId`.
`Future<DeleteModelResponse>`	`deleteModel(DeleteModelRequest request, AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)`	Deletes a custom model.
`String`	`getClientCommonLibraryVersion()`
`Future<GetDedicatedAiClusterResponse>`	`getDedicatedAiCluster(GetDedicatedAiClusterRequest request, AsyncHandler<GetDedicatedAiClusterRequest,GetDedicatedAiClusterResponse> handler)`	Gets information about a dedicated AI cluster.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`Future<GetEndpointResponse>`	`getEndpoint(GetEndpointRequest request, AsyncHandler<GetEndpointRequest,GetEndpointResponse> handler)`	Gets information about an endpoint.
`Future<GetGenerativeAiPrivateEndpointResponse>`	`getGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointRequest request, AsyncHandler<GetGenerativeAiPrivateEndpointRequest,GetGenerativeAiPrivateEndpointResponse> handler)`	Retrieves an Generative AI private endpoint using a `privateEndpointId`.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Future<GetModelResponse>`	`getModel(GetModelRequest request, AsyncHandler<GetModelRequest,GetModelResponse> handler)`	Gets information about a custom model.
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)`	Gets the details of a work request.
`Future<ListDedicatedAiClustersResponse>`	`listDedicatedAiClusters(ListDedicatedAiClustersRequest request, AsyncHandler<ListDedicatedAiClustersRequest,ListDedicatedAiClustersResponse> handler)`	Lists the dedicated AI clusters in a specific compartment.
`Future<ListEndpointsResponse>`	`listEndpoints(ListEndpointsRequest request, AsyncHandler<ListEndpointsRequest,ListEndpointsResponse> handler)`	Lists the endpoints of a specific compartment.
`Future<ListGenerativeAiPrivateEndpointsResponse>`	`listGenerativeAiPrivateEndpoints(ListGenerativeAiPrivateEndpointsRequest request, AsyncHandler<ListGenerativeAiPrivateEndpointsRequest,ListGenerativeAiPrivateEndpointsResponse> handler)`	Lists all Generative AI private endpoints in the specified compartment.
`Future<ListModelsResponse>`	`listModels(ListModelsRequest request, AsyncHandler<ListModelsRequest,ListModelsResponse> handler)`	Lists the models in a specific compartment.
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)`	Lists the errors for a work request.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)`	Lists the logs for a work request.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)`	Lists the work requests in a compartment.
`void`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)`	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)`	Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)`	Sets the region to call (ex, ‘us-phoenix-1’).
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`Future<UpdateDedicatedAiClusterResponse>`	`updateDedicatedAiCluster(UpdateDedicatedAiClusterRequest request, AsyncHandler<UpdateDedicatedAiClusterRequest,UpdateDedicatedAiClusterResponse> handler)`	Updates a dedicated AI cluster.
`Future<UpdateEndpointResponse>`	`updateEndpoint(UpdateEndpointRequest request, AsyncHandler<UpdateEndpointRequest,UpdateEndpointResponse> handler)`	Updates the properties of an endpoint.
`Future<UpdateGenerativeAiPrivateEndpointResponse>`	`updateGenerativeAiPrivateEndpoint(UpdateGenerativeAiPrivateEndpointRequest request, AsyncHandler<UpdateGenerativeAiPrivateEndpointRequest,UpdateGenerativeAiPrivateEndpointResponse> handler)`	Updates a Generative AI private endpoint using a `privateEndpointId`.
`Future<UpdateModelResponse>`	`updateModel(UpdateModelRequest request, AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)`	Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.generativeai.GenerativeAiAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for GenerativeAi.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - GenerativeAiAsyncClient
```
@Deprecated
public GenerativeAiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - GenerativeAiAsyncClient
```
@Deprecated
public GenerativeAiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - GenerativeAiAsyncClient
```
@Deprecated
public GenerativeAiAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - GenerativeAiAsyncClient
```
@Deprecated
public GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - GenerativeAiAsyncClient
```
@Deprecated
public GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - GenerativeAiAsyncClient
```
@Deprecated
public GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - GenerativeAiAsyncClient
```
@Deprecated
public GenerativeAiAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
- Method Detail
  - builder
```
public static GenerativeAiAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: GenerativeAiAsync
    
    Sets the region to call (ex, Region.US_PHOENIX_1).
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
    
    Specified by:
    
    setRegion in interface GenerativeAiAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: GenerativeAiAsync
    
    Sets the region to call (ex, ‘us-phoenix-1’).
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Specified by:
    
    setRegion in interface GenerativeAiAsync
    
    Parameters:
    
    regionId - The public region ID.
  - changeDedicatedAiClusterCompartment
```
public Future<ChangeDedicatedAiClusterCompartmentResponse> changeDedicatedAiClusterCompartment(ChangeDedicatedAiClusterCompartmentRequest request,
                                                                                               AsyncHandler<ChangeDedicatedAiClusterCompartmentRequest,ChangeDedicatedAiClusterCompartmentResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Moves a dedicated AI cluster into a different compartment within the same tenancy.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Specified by:
    
    changeDedicatedAiClusterCompartment in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeEndpointCompartment
```
public Future<ChangeEndpointCompartmentResponse> changeEndpointCompartment(ChangeEndpointCompartmentRequest request,
                                                                           AsyncHandler<ChangeEndpointCompartmentRequest,ChangeEndpointCompartmentResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Moves an endpoint into a different compartment within the same tenancy.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Specified by:
    
    changeEndpointCompartment in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeGenerativeAiPrivateEndpointCompartment
```
public Future<ChangeGenerativeAiPrivateEndpointCompartmentResponse> changeGenerativeAiPrivateEndpointCompartment(ChangeGenerativeAiPrivateEndpointCompartmentRequest request,
                                                                                                                 AsyncHandler<ChangeGenerativeAiPrivateEndpointCompartmentRequest,ChangeGenerativeAiPrivateEndpointCompartmentResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Moves a Generative AI private endpoint into a different compartment.
    When provided, If-Match is checked against ETag values of the resource.
    
    Specified by:
    
    changeGenerativeAiPrivateEndpointCompartment in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeModelCompartment
```
public Future<ChangeModelCompartmentResponse> changeModelCompartment(ChangeModelCompartmentRequest request,
                                                                     AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Moves a custom model into a different compartment.
    For information about moving resources between compartments, see Moving Resources to a Different Compartment.
    
    Specified by:
    
    changeModelCompartment in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createDedicatedAiCluster
```
public Future<CreateDedicatedAiClusterResponse> createDedicatedAiCluster(CreateDedicatedAiClusterRequest request,
                                                                         AsyncHandler<CreateDedicatedAiClusterRequest,CreateDedicatedAiClusterResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Creates a dedicated AI cluster.
    
    Specified by:
    
    createDedicatedAiCluster in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createEndpoint
```
public Future<CreateEndpointResponse> createEndpoint(CreateEndpointRequest request,
                                                     AsyncHandler<CreateEndpointRequest,CreateEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Creates an endpoint.
    The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the endpoint creation progress.
    
    Specified by:
    
    createEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createGenerativeAiPrivateEndpoint
```
public Future<CreateGenerativeAiPrivateEndpointResponse> createGenerativeAiPrivateEndpoint(CreateGenerativeAiPrivateEndpointRequest request,
                                                                                           AsyncHandler<CreateGenerativeAiPrivateEndpointRequest,CreateGenerativeAiPrivateEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Creates a Generative AI private endpoint.
    
    Specified by:
    
    createGenerativeAiPrivateEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createModel
```
public Future<CreateModelResponse> createModel(CreateModelRequest request,
                                               AsyncHandler<CreateModelRequest,CreateModelResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Creates a custom model by fine-tuning a base model with your own dataset.
    You can create a new custom models or create a new version of existing custom model..
    
    The header contains an opc-work-request-id, which is the id for the WorkRequest that tracks the model creation progress.
    
    Specified by:
    
    createModel in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteDedicatedAiCluster
```
public Future<DeleteDedicatedAiClusterResponse> deleteDedicatedAiCluster(DeleteDedicatedAiClusterRequest request,
                                                                         AsyncHandler<DeleteDedicatedAiClusterRequest,DeleteDedicatedAiClusterResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Deletes a dedicated AI cluster.
    You can only delete clusters without attached resources. Before you delete a hosting dedicated AI cluster, you must delete the endpoints associated to that cluster. Before you delete a fine-tuning dedicated AI cluster, you must delete the custom model on that cluster. The delete action permanently deletes the cluster. This action can't be undone.
    
    Specified by:
    
    deleteDedicatedAiCluster in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteEndpoint
```
public Future<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest request,
                                                     AsyncHandler<DeleteEndpointRequest,DeleteEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Deletes an endpoint.
    
    Specified by:
    
    deleteEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteGenerativeAiPrivateEndpoint
```
public Future<DeleteGenerativeAiPrivateEndpointResponse> deleteGenerativeAiPrivateEndpoint(DeleteGenerativeAiPrivateEndpointRequest request,
                                                                                           AsyncHandler<DeleteGenerativeAiPrivateEndpointRequest,DeleteGenerativeAiPrivateEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Deletes a Generative AI private endpoint using privateEndpointId.
    
    Specified by:
    
    deleteGenerativeAiPrivateEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteModel
```
public Future<DeleteModelResponse> deleteModel(DeleteModelRequest request,
                                               AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Deletes a custom model.
    A model shouldn’t be deleted if there’s one or more active endpoints associated with that model.
    
    Specified by:
    
    deleteModel in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getDedicatedAiCluster
```
public Future<GetDedicatedAiClusterResponse> getDedicatedAiCluster(GetDedicatedAiClusterRequest request,
                                                                   AsyncHandler<GetDedicatedAiClusterRequest,GetDedicatedAiClusterResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Gets information about a dedicated AI cluster.
    
    Specified by:
    
    getDedicatedAiCluster in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getEndpoint
```
public Future<GetEndpointResponse> getEndpoint(GetEndpointRequest request,
                                               AsyncHandler<GetEndpointRequest,GetEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Gets information about an endpoint.
    
    Specified by:
    
    getEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getGenerativeAiPrivateEndpoint
```
public Future<GetGenerativeAiPrivateEndpointResponse> getGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointRequest request,
                                                                                     AsyncHandler<GetGenerativeAiPrivateEndpointRequest,GetGenerativeAiPrivateEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Retrieves an Generative AI private endpoint using a privateEndpointId.
    
    Specified by:
    
    getGenerativeAiPrivateEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getModel
```
public Future<GetModelResponse> getModel(GetModelRequest request,
                                         AsyncHandler<GetModelRequest,GetModelResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Gets information about a custom model.
    
    Specified by:
    
    getModel in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getWorkRequest
```
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Gets the details of a work request.
    
    Specified by:
    
    getWorkRequest in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listDedicatedAiClusters
```
public Future<ListDedicatedAiClustersResponse> listDedicatedAiClusters(ListDedicatedAiClustersRequest request,
                                                                       AsyncHandler<ListDedicatedAiClustersRequest,ListDedicatedAiClustersResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Lists the dedicated AI clusters in a specific compartment.
    
    Specified by:
    
    listDedicatedAiClusters in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listEndpoints
```
public Future<ListEndpointsResponse> listEndpoints(ListEndpointsRequest request,
                                                   AsyncHandler<ListEndpointsRequest,ListEndpointsResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Lists the endpoints of a specific compartment.
    
    Specified by:
    
    listEndpoints in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listGenerativeAiPrivateEndpoints
```
public Future<ListGenerativeAiPrivateEndpointsResponse> listGenerativeAiPrivateEndpoints(ListGenerativeAiPrivateEndpointsRequest request,
                                                                                         AsyncHandler<ListGenerativeAiPrivateEndpointsRequest,ListGenerativeAiPrivateEndpointsResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Lists all Generative AI private endpoints in the specified compartment.
    
    Specified by:
    
    listGenerativeAiPrivateEndpoints in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listModels
```
public Future<ListModelsResponse> listModels(ListModelsRequest request,
                                             AsyncHandler<ListModelsRequest,ListModelsResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Lists the models in a specific compartment.
    Includes pretrained base models and fine-tuned custom models.
    
    Specified by:
    
    listModels in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestErrors
```
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Lists the errors for a work request.
    
    Specified by:
    
    listWorkRequestErrors in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestLogs
```
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Lists the logs for a work request.
    
    Specified by:
    
    listWorkRequestLogs in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequests
```
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateDedicatedAiCluster
```
public Future<UpdateDedicatedAiClusterResponse> updateDedicatedAiCluster(UpdateDedicatedAiClusterRequest request,
                                                                         AsyncHandler<UpdateDedicatedAiClusterRequest,UpdateDedicatedAiClusterResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Updates a dedicated AI cluster.
    
    Specified by:
    
    updateDedicatedAiCluster in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateEndpoint
```
public Future<UpdateEndpointResponse> updateEndpoint(UpdateEndpointRequest request,
                                                     AsyncHandler<UpdateEndpointRequest,UpdateEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Updates the properties of an endpoint.
    
    Specified by:
    
    updateEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateGenerativeAiPrivateEndpoint
```
public Future<UpdateGenerativeAiPrivateEndpointResponse> updateGenerativeAiPrivateEndpoint(UpdateGenerativeAiPrivateEndpointRequest request,
                                                                                           AsyncHandler<UpdateGenerativeAiPrivateEndpointRequest,UpdateGenerativeAiPrivateEndpointResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Updates a Generative AI private endpoint using a privateEndpointId.
    
    Specified by:
    
    updateGenerativeAiPrivateEndpoint in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateModel
```
public Future<UpdateModelResponse> updateModel(UpdateModelRequest request,
                                               AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)
```
    Description copied from interface: GenerativeAiAsync
    
    Updates the properties of a custom model such as name, description, version, freeform tags, and defined tags.
    
    Specified by:
    
    updateModel in interface GenerativeAiAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
    The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only.
    This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)
```

Class GenerativeAiAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.generativeai.GenerativeAiAsync

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

GenerativeAiAsyncClient

GenerativeAiAsyncClient

GenerativeAiAsyncClient

GenerativeAiAsyncClient

GenerativeAiAsyncClient

GenerativeAiAsyncClient

GenerativeAiAsyncClient

Method Detail

builder

setRegion

setRegion

changeDedicatedAiClusterCompartment

changeEndpointCompartment

changeGenerativeAiPrivateEndpointCompartment

changeModelCompartment

createDedicatedAiCluster

createEndpoint

createGenerativeAiPrivateEndpoint

createModel

deleteDedicatedAiCluster

deleteEndpoint

deleteGenerativeAiPrivateEndpoint

deleteModel

getDedicatedAiCluster

getEndpoint

getGenerativeAiPrivateEndpoint

getModel

getWorkRequest

listDedicatedAiClusters

listEndpoints

listGenerativeAiPrivateEndpoints

listModels

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateDedicatedAiCluster

updateEndpoint

updateGenerativeAiPrivateEndpoint

updateModel

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient

clientCall