com.oracle.bmc.generativeaiagent

Class GenerativeAiAgentAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.generativeaiagent.GenerativeAiAgentAsyncClient

All Implemented Interfaces:

GenerativeAiAgentAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public class GenerativeAiAgentAsyncClient
extends BaseAsyncClient
implements GenerativeAiAgentAsync

Async client implementation for GenerativeAiAgent 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 and Description
static class	GenerativeAiAgentAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 GenerativeAiAgent.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static GenerativeAiAgentAsyncClient.Builder	builder() Create a builder for this client.
Future<CancelWorkRequestResponse>	cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler) CancelWorkRequest
Future<ChangeAgentCompartmentResponse>	changeAgentCompartment(ChangeAgentCompartmentRequest request, AsyncHandler<ChangeAgentCompartmentRequest,ChangeAgentCompartmentResponse> handler) ChangeAgentCompartment
Future<ChangeAgentEndpointCompartmentResponse>	changeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request, AsyncHandler<ChangeAgentEndpointCompartmentRequest,ChangeAgentEndpointCompartmentResponse> handler) ChangeAgentEndpointCompartment
Future<ChangeKnowledgeBaseCompartmentResponse>	changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request, AsyncHandler<ChangeKnowledgeBaseCompartmentRequest,ChangeKnowledgeBaseCompartmentResponse> handler) ChangeKnowledgeBaseCompartment
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<CreateAgentResponse>	createAgent(CreateAgentRequest request, AsyncHandler<CreateAgentRequest,CreateAgentResponse> handler) CreateAgent
Future<CreateAgentEndpointResponse>	createAgentEndpoint(CreateAgentEndpointRequest request, AsyncHandler<CreateAgentEndpointRequest,CreateAgentEndpointResponse> handler) CreateAgentEndpoint
Future<CreateDataIngestionJobResponse>	createDataIngestionJob(CreateDataIngestionJobRequest request, AsyncHandler<CreateDataIngestionJobRequest,CreateDataIngestionJobResponse> handler) CreateDataIngestionJob
Future<CreateDataSourceResponse>	createDataSource(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResponse> handler) CreateDataSource
Future<CreateKnowledgeBaseResponse>	createKnowledgeBase(CreateKnowledgeBaseRequest request, AsyncHandler<CreateKnowledgeBaseRequest,CreateKnowledgeBaseResponse> handler) CreateKnowledgeBase
Future<DeleteAgentResponse>	deleteAgent(DeleteAgentRequest request, AsyncHandler<DeleteAgentRequest,DeleteAgentResponse> handler) DeleteAgent
Future<DeleteAgentEndpointResponse>	deleteAgentEndpoint(DeleteAgentEndpointRequest request, AsyncHandler<DeleteAgentEndpointRequest,DeleteAgentEndpointResponse> handler) DeleteAgentEndpoint
Future<DeleteDataIngestionJobResponse>	deleteDataIngestionJob(DeleteDataIngestionJobRequest request, AsyncHandler<DeleteDataIngestionJobRequest,DeleteDataIngestionJobResponse> handler) DeleteDataIngestionJob
Future<DeleteDataSourceResponse>	deleteDataSource(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResponse> handler) DeleteDataSource
Future<DeleteKnowledgeBaseResponse>	deleteKnowledgeBase(DeleteKnowledgeBaseRequest request, AsyncHandler<DeleteKnowledgeBaseRequest,DeleteKnowledgeBaseResponse> handler) DeleteKnowledgeBase
Future<GetAgentResponse>	getAgent(GetAgentRequest request, AsyncHandler<GetAgentRequest,GetAgentResponse> handler) GetAgent
Future<GetAgentEndpointResponse>	getAgentEndpoint(GetAgentEndpointRequest request, AsyncHandler<GetAgentEndpointRequest,GetAgentEndpointResponse> handler) GetAgentEndpoint
String	getClientCommonLibraryVersion()
Future<GetDataIngestionJobResponse>	getDataIngestionJob(GetDataIngestionJobRequest request, AsyncHandler<GetDataIngestionJobRequest,GetDataIngestionJobResponse> handler) GetDataIngestionJob
Future<GetDataIngestionJobLogContentResponse>	getDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request, AsyncHandler<GetDataIngestionJobLogContentRequest,GetDataIngestionJobLogContentResponse> handler) GetDataIngestionJobLogContent
Future<GetDataSourceResponse>	getDataSource(GetDataSourceRequest request, AsyncHandler<GetDataSourceRequest,GetDataSourceResponse> handler) GetDataSource
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetKnowledgeBaseResponse>	getKnowledgeBase(GetKnowledgeBaseRequest request, AsyncHandler<GetKnowledgeBaseRequest,GetKnowledgeBaseResponse> handler) GetKnowledgeBase
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) GetWorkRequest
Future<ListAgentEndpointsResponse>	listAgentEndpoints(ListAgentEndpointsRequest request, AsyncHandler<ListAgentEndpointsRequest,ListAgentEndpointsResponse> handler) ListAgentEndpoints
Future<ListAgentsResponse>	listAgents(ListAgentsRequest request, AsyncHandler<ListAgentsRequest,ListAgentsResponse> handler) ListAgents
Future<ListDataIngestionJobsResponse>	listDataIngestionJobs(ListDataIngestionJobsRequest request, AsyncHandler<ListDataIngestionJobsRequest,ListDataIngestionJobsResponse> handler) ListDataIngestionJobs
Future<ListDataSourcesResponse>	listDataSources(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResponse> handler) ListDataSources
Future<ListKnowledgeBasesResponse>	listKnowledgeBases(ListKnowledgeBasesRequest request, AsyncHandler<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse> handler) ListKnowledgeBases
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) ListWorkRequestErrors
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) ListWorkRequestLogs
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) ListWorkRequests
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’).
Future<UpdateAgentResponse>	updateAgent(UpdateAgentRequest request, AsyncHandler<UpdateAgentRequest,UpdateAgentResponse> handler) UpdateAgent
Future<UpdateAgentEndpointResponse>	updateAgentEndpoint(UpdateAgentEndpointRequest request, AsyncHandler<UpdateAgentEndpointRequest,UpdateAgentEndpointResponse> handler) UpdateAgentEndpoint
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateDataSourceResponse>	updateDataSource(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResponse> handler) UpdateDataSource
Future<UpdateKnowledgeBaseResponse>	updateKnowledgeBase(UpdateKnowledgeBaseRequest request, AsyncHandler<UpdateKnowledgeBaseRequest,UpdateKnowledgeBaseResponse> handler) UpdateKnowledgeBase
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 com.oracle.bmc.generativeaiagent.GenerativeAiAgentAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for GenerativeAiAgent.

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

GenerativeAiAgentAsyncClient

@Deprecated
public GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

GenerativeAiAgentAsyncClient

@Deprecated
public GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

GenerativeAiAgentAsyncClient

@Deprecated
public GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

GenerativeAiAgentAsyncClient

@Deprecated
public GenerativeAiAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration,
                                                ClientConfigurator clientConfigurator,
                                                RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GenerativeAiAgentAsyncClient

@Deprecated
public GenerativeAiAgentAsyncClient(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 GenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GenerativeAiAgentAsyncClient

@Deprecated
public GenerativeAiAgentAsyncClient(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 GenerativeAiAgentAsyncClient.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)

GenerativeAiAgentAsyncClient

@Deprecated
public GenerativeAiAgentAsyncClient(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 GenerativeAiAgentAsyncClient.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 GenerativeAiAgentAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: GenerativeAiAgentAsync

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 GenerativeAiAgentAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: GenerativeAiAgentAsync

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 GenerativeAiAgentAsync

Parameters:

regionId - The public region ID.

cancelWorkRequest

public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                           AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

CancelWorkRequest

Cancels a work request.

Specified by:

cancelWorkRequest in interface GenerativeAiAgentAsync

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.

changeAgentCompartment

public Future<ChangeAgentCompartmentResponse> changeAgentCompartment(ChangeAgentCompartmentRequest request,
                                                                     AsyncHandler<ChangeAgentCompartmentRequest,ChangeAgentCompartmentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ChangeAgentCompartment

Moves an agent into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

Specified by:

changeAgentCompartment in interface GenerativeAiAgentAsync

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.

changeAgentEndpointCompartment

public Future<ChangeAgentEndpointCompartmentResponse> changeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request,
                                                                                     AsyncHandler<ChangeAgentEndpointCompartmentRequest,ChangeAgentEndpointCompartmentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ChangeAgentEndpointCompartment

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](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

Specified by:

changeAgentEndpointCompartment in interface GenerativeAiAgentAsync

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.

changeKnowledgeBaseCompartment

public Future<ChangeKnowledgeBaseCompartmentResponse> changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request,
                                                                                     AsyncHandler<ChangeKnowledgeBaseCompartmentRequest,ChangeKnowledgeBaseCompartmentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ChangeKnowledgeBaseCompartment

Moves a knowledge base into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

Specified by:

changeKnowledgeBaseCompartment in interface GenerativeAiAgentAsync

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.

createAgent

public Future<CreateAgentResponse> createAgent(CreateAgentRequest request,
                                               AsyncHandler<CreateAgentRequest,CreateAgentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

CreateAgent

Creates an agent.

Specified by:

createAgent in interface GenerativeAiAgentAsync

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.

createAgentEndpoint

public Future<CreateAgentEndpointResponse> createAgentEndpoint(CreateAgentEndpointRequest request,
                                                               AsyncHandler<CreateAgentEndpointRequest,CreateAgentEndpointResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

CreateAgentEndpoint

Creates an endpoint.

Specified by:

createAgentEndpoint in interface GenerativeAiAgentAsync

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.

createDataIngestionJob

public Future<CreateDataIngestionJobResponse> createDataIngestionJob(CreateDataIngestionJobRequest request,
                                                                     AsyncHandler<CreateDataIngestionJobRequest,CreateDataIngestionJobResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

CreateDataIngestionJob

Creates a data ingestion job.

Specified by:

createDataIngestionJob in interface GenerativeAiAgentAsync

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.

createDataSource

public Future<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest request,
                                                         AsyncHandler<CreateDataSourceRequest,CreateDataSourceResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

CreateDataSource

Creates a data source.

Specified by:

createDataSource in interface GenerativeAiAgentAsync

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.

createKnowledgeBase

public Future<CreateKnowledgeBaseResponse> createKnowledgeBase(CreateKnowledgeBaseRequest request,
                                                               AsyncHandler<CreateKnowledgeBaseRequest,CreateKnowledgeBaseResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

CreateKnowledgeBase

Creates a knowledge base.

Specified by:

createKnowledgeBase in interface GenerativeAiAgentAsync

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.

deleteAgent

public Future<DeleteAgentResponse> deleteAgent(DeleteAgentRequest request,
                                               AsyncHandler<DeleteAgentRequest,DeleteAgentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

DeleteAgent

Deletes an agent.

Specified by:

deleteAgent in interface GenerativeAiAgentAsync

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.

deleteAgentEndpoint

public Future<DeleteAgentEndpointResponse> deleteAgentEndpoint(DeleteAgentEndpointRequest request,
                                                               AsyncHandler<DeleteAgentEndpointRequest,DeleteAgentEndpointResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

DeleteAgentEndpoint

Deletes an endpoint.

Specified by:

deleteAgentEndpoint in interface GenerativeAiAgentAsync

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.

deleteDataIngestionJob

public Future<DeleteDataIngestionJobResponse> deleteDataIngestionJob(DeleteDataIngestionJobRequest request,
                                                                     AsyncHandler<DeleteDataIngestionJobRequest,DeleteDataIngestionJobResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

DeleteDataIngestionJob

Deletes a data ingestion job.

Specified by:

deleteDataIngestionJob in interface GenerativeAiAgentAsync

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.

deleteDataSource

public Future<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest request,
                                                         AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

DeleteDataSource

Deletes a data source.

Specified by:

deleteDataSource in interface GenerativeAiAgentAsync

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.

deleteKnowledgeBase

public Future<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(DeleteKnowledgeBaseRequest request,
                                                               AsyncHandler<DeleteKnowledgeBaseRequest,DeleteKnowledgeBaseResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

DeleteKnowledgeBase

Deletes a knowledge base.

Specified by:

deleteKnowledgeBase in interface GenerativeAiAgentAsync

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.

getAgent

public Future<GetAgentResponse> getAgent(GetAgentRequest request,
                                         AsyncHandler<GetAgentRequest,GetAgentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

GetAgent

Gets information about an agent.

Specified by:

getAgent in interface GenerativeAiAgentAsync

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.

getAgentEndpoint

public Future<GetAgentEndpointResponse> getAgentEndpoint(GetAgentEndpointRequest request,
                                                         AsyncHandler<GetAgentEndpointRequest,GetAgentEndpointResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

GetAgentEndpoint

Gets information about an endpoint.

Specified by:

getAgentEndpoint in interface GenerativeAiAgentAsync

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.

getDataIngestionJob

public Future<GetDataIngestionJobResponse> getDataIngestionJob(GetDataIngestionJobRequest request,
                                                               AsyncHandler<GetDataIngestionJobRequest,GetDataIngestionJobResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

GetDataIngestionJob

Gets information about a data ingestion job.

Specified by:

getDataIngestionJob in interface GenerativeAiAgentAsync

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.

getDataIngestionJobLogContent

public Future<GetDataIngestionJobLogContentResponse> getDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request,
                                                                                   AsyncHandler<GetDataIngestionJobLogContentRequest,GetDataIngestionJobLogContentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

GetDataIngestionJobLogContent

Returns the raw log file for the specified data ingestion job in text format.

Specified by:

getDataIngestionJobLogContent in interface GenerativeAiAgentAsync

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.

getDataSource

public Future<GetDataSourceResponse> getDataSource(GetDataSourceRequest request,
                                                   AsyncHandler<GetDataSourceRequest,GetDataSourceResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

GetDataSource

Gets information about a data source.

Specified by:

getDataSource in interface GenerativeAiAgentAsync

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.

getKnowledgeBase

public Future<GetKnowledgeBaseResponse> getKnowledgeBase(GetKnowledgeBaseRequest request,
                                                         AsyncHandler<GetKnowledgeBaseRequest,GetKnowledgeBaseResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

GetKnowledgeBase

Gets information about a knowledge base.

Specified by:

getKnowledgeBase in interface GenerativeAiAgentAsync

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: GenerativeAiAgentAsync

GetWorkRequest

Gets the details of a work request.

Specified by:

getWorkRequest in interface GenerativeAiAgentAsync

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.

listAgentEndpoints

public Future<ListAgentEndpointsResponse> listAgentEndpoints(ListAgentEndpointsRequest request,
                                                             AsyncHandler<ListAgentEndpointsRequest,ListAgentEndpointsResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ListAgentEndpoints

Gets a list of endpoints.

Specified by:

listAgentEndpoints in interface GenerativeAiAgentAsync

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.

listAgents

public Future<ListAgentsResponse> listAgents(ListAgentsRequest request,
                                             AsyncHandler<ListAgentsRequest,ListAgentsResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ListAgents

Gets a list of agents.

Specified by:

listAgents in interface GenerativeAiAgentAsync

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.

listDataIngestionJobs

public Future<ListDataIngestionJobsResponse> listDataIngestionJobs(ListDataIngestionJobsRequest request,
                                                                   AsyncHandler<ListDataIngestionJobsRequest,ListDataIngestionJobsResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ListDataIngestionJobs

Gets a list of data ingestion jobs.

Specified by:

listDataIngestionJobs in interface GenerativeAiAgentAsync

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.

listDataSources

public Future<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest request,
                                                       AsyncHandler<ListDataSourcesRequest,ListDataSourcesResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ListDataSources

Gets a list of data sources.

Specified by:

listDataSources in interface GenerativeAiAgentAsync

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.

listKnowledgeBases

public Future<ListKnowledgeBasesResponse> listKnowledgeBases(ListKnowledgeBasesRequest request,
                                                             AsyncHandler<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

ListKnowledgeBases

Gets a list of knowledge bases.

Specified by:

listKnowledgeBases in interface GenerativeAiAgentAsync

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: GenerativeAiAgentAsync

ListWorkRequestErrors

Lists the errors for a work request.

Specified by:

listWorkRequestErrors in interface GenerativeAiAgentAsync

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: GenerativeAiAgentAsync

ListWorkRequestLogs

Lists the logs for a work request.

Specified by:

listWorkRequestLogs in interface GenerativeAiAgentAsync

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: GenerativeAiAgentAsync

ListWorkRequests

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface GenerativeAiAgentAsync

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.

updateAgent

public Future<UpdateAgentResponse> updateAgent(UpdateAgentRequest request,
                                               AsyncHandler<UpdateAgentRequest,UpdateAgentResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

UpdateAgent

Updates an agent.

Specified by:

updateAgent in interface GenerativeAiAgentAsync

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.

updateAgentEndpoint

public Future<UpdateAgentEndpointResponse> updateAgentEndpoint(UpdateAgentEndpointRequest request,
                                                               AsyncHandler<UpdateAgentEndpointRequest,UpdateAgentEndpointResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

UpdateAgentEndpoint

Updates an endpoint.

Specified by:

updateAgentEndpoint in interface GenerativeAiAgentAsync

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.

updateDataSource

public Future<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest request,
                                                         AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

UpdateDataSource

Updates a data source.

Specified by:

updateDataSource in interface GenerativeAiAgentAsync

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.

updateKnowledgeBase

public Future<UpdateKnowledgeBaseResponse> updateKnowledgeBase(UpdateKnowledgeBaseRequest request,
                                                               AsyncHandler<UpdateKnowledgeBaseRequest,UpdateKnowledgeBaseResponse> handler)

Description copied from interface: GenerativeAiAgentAsync

UpdateKnowledgeBase

Updates a knowledge base.

Specified by:

updateKnowledgeBase in interface GenerativeAiAgentAsync

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)