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 GenerativeAiAgentAsyncAsync 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 anInputStream, 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 classGenerativeAiAgentAsyncClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for GenerativeAiAgent.
-
Constructor Summary
Constructors Constructor Description GenerativeAiAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.GenerativeAiAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.GenerativeAiAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GenerativeAiAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.generativeaiagent.GenerativeAiAgentAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
GenerativeAiAgentAsyncClient
@Deprecated public GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
GenerativeAiAgentAsyncClient
@Deprecated public GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
GenerativeAiAgentAsyncClient
@Deprecated public GenerativeAiAgentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
GenerativeAiAgentAsyncClient
@Deprecated public GenerativeAiAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
GenerativeAiAgentAsyncClient
@Deprecated public GenerativeAiAgentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeGenerativeAiAgentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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:GenerativeAiAgentAsyncSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceGenerativeAiAgentAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:GenerativeAiAgentAsyncSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceGenerativeAiAgentAsync- Parameters:
regionId- The public region ID.
-
cancelWorkRequest
public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
Description copied from interface:GenerativeAiAgentAsyncCancels a work request.- Specified by:
cancelWorkRequestin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncMoves an agent into a different compartment within the same tenancy.For information about moving resources between compartments, see Moving Resources to a Different Compartment.
- Specified by:
changeAgentCompartmentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncMoves 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:
changeAgentEndpointCompartmentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncMoves 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.
- Specified by:
changeKnowledgeBaseCompartmentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncCreates an agent.- Specified by:
createAgentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncCreates an endpoint.- Specified by:
createAgentEndpointin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncCreates a data ingestion job.- Specified by:
createDataIngestionJobin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncCreates a data source.- Specified by:
createDataSourcein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncCreates a knowledge base.- Specified by:
createKnowledgeBasein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
createTool
public Future<CreateToolResponse> createTool(CreateToolRequest request, AsyncHandler<CreateToolRequest,CreateToolResponse> handler)
Description copied from interface:GenerativeAiAgentAsyncCreates a tool.- Specified by:
createToolin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncDeletes an agent.- Specified by:
deleteAgentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncDeletes an endpoint.- Specified by:
deleteAgentEndpointin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncDeletes a data ingestion job.- Specified by:
deleteDataIngestionJobin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncDeletes a data source.- Specified by:
deleteDataSourcein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncDeletes a knowledge base.- Specified by:
deleteKnowledgeBasein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
deleteTool
public Future<DeleteToolResponse> deleteTool(DeleteToolRequest request, AsyncHandler<DeleteToolRequest,DeleteToolResponse> handler)
Description copied from interface:GenerativeAiAgentAsyncDeletes a tool.- Specified by:
deleteToolin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets information about an agent.- Specified by:
getAgentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets information about an endpoint.- Specified by:
getAgentEndpointin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets information about a data ingestion job.- Specified by:
getDataIngestionJobin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncReturns the raw log file for the specified data ingestion job in text format.- Specified by:
getDataIngestionJobLogContentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets information about a data source.- Specified by:
getDataSourcein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets information about a knowledge base.- Specified by:
getKnowledgeBasein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
getTool
public Future<GetToolResponse> getTool(GetToolRequest request, AsyncHandler<GetToolRequest,GetToolResponse> handler)
Description copied from interface:GenerativeAiAgentAsyncGets information about a tool.- Specified by:
getToolin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets the details of a work request.- Specified by:
getWorkRequestin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets a list of endpoints.- Specified by:
listAgentEndpointsin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets a list of agents.- Specified by:
listAgentsin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets a list of data ingestion jobs.- Specified by:
listDataIngestionJobsin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets a list of data sources.- Specified by:
listDataSourcesin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncGets a list of knowledge bases.- Specified by:
listKnowledgeBasesin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
listTools
public Future<ListToolsResponse> listTools(ListToolsRequest request, AsyncHandler<ListToolsRequest,ListToolsResponse> handler)
Description copied from interface:GenerativeAiAgentAsyncGets a list of tools.- Specified by:
listToolsin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncLists the errors for a work request.- Specified by:
listWorkRequestErrorsin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncLists the logs for a work request.- Specified by:
listWorkRequestLogsin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncLists the work requests in a compartment.- Specified by:
listWorkRequestsin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncUpdates an agent.- Specified by:
updateAgentin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncUpdates an endpoint.- Specified by:
updateAgentEndpointin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncUpdates a data source.- Specified by:
updateDataSourcein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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:GenerativeAiAgentAsyncUpdates a knowledge base.- Specified by:
updateKnowledgeBasein interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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.
-
updateTool
public Future<UpdateToolResponse> updateTool(UpdateToolRequest request, AsyncHandler<UpdateToolRequest,UpdateToolResponse> handler)
Description copied from interface:GenerativeAiAgentAsyncUpdates a tool.- Specified by:
updateToolin interfaceGenerativeAiAgentAsync- Parameters:
request- The request object containing the details to sendhandler- 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 userequiredParametersMap- 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 backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
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)
-
-