java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.aidocument.AIServiceDocumentAsyncClient

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AIServiceDocumentAsyncClient.Builder
Builder class for this client.

Field Summary

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

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Future<AddModelLockResponse>`	`addModelLock(AddModelLockRequest request, AsyncHandler<AddModelLockRequest,AddModelLockResponse> handler)`	Adds a lock to a resource.
`Future<AddProjectLockResponse>`	`addProjectLock(AddProjectLockRequest request, AsyncHandler<AddProjectLockRequest,AddProjectLockResponse> handler)`	Adds a lock to a resource.
`Future<AnalyzeDocumentResponse>`	`analyzeDocument(AnalyzeDocumentRequest request, AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResponse> handler)`	Perform different types of document analysis.
`static AIServiceDocumentAsyncClient.Builder`	`builder()`	Create a builder for this client.
`Future<CancelProcessorJobResponse>`	`cancelProcessorJob(CancelProcessorJobRequest request, AsyncHandler<CancelProcessorJobRequest,CancelProcessorJobResponse> handler)`	Cancel a processor job.
`Future<CancelWorkRequestResponse>`	`cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)`	Cancel the work request with the given ID.
`Future<ChangeModelCompartmentResponse>`	`changeModelCompartment(ChangeModelCompartmentRequest request, AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)`	Moves a model from one compartment to another.
`Future<ChangeProjectCompartmentResponse>`	`changeProjectCompartment(ChangeProjectCompartmentRequest request, AsyncHandler<ChangeProjectCompartmentRequest,ChangeProjectCompartmentResponse> handler)`	Move a project from one compartment to another.
`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<CreateModelResponse>`	`createModel(CreateModelRequest request, AsyncHandler<CreateModelRequest,CreateModelResponse> handler)`	Create a new model.
`Future<CreateProcessorJobResponse>`	`createProcessorJob(CreateProcessorJobRequest request, AsyncHandler<CreateProcessorJobRequest,CreateProcessorJobResponse> handler)`	Create a processor job for document analysis.
`Future<CreateProjectResponse>`	`createProject(CreateProjectRequest request, AsyncHandler<CreateProjectRequest,CreateProjectResponse> handler)`	Create a new project.
`Future<DeleteModelResponse>`	`deleteModel(DeleteModelRequest request, AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)`	Delete a model by identifier.
`Future<DeleteProjectResponse>`	`deleteProject(DeleteProjectRequest request, AsyncHandler<DeleteProjectRequest,DeleteProjectResponse> handler)`	Delete a project by identifier.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Future<GetModelResponse>`	`getModel(GetModelRequest request, AsyncHandler<GetModelRequest,GetModelResponse> handler)`	Get a model by identifier.
`Future<GetProcessorJobResponse>`	`getProcessorJob(GetProcessorJobRequest request, AsyncHandler<GetProcessorJobRequest,GetProcessorJobResponse> handler)`	Get the details of a processor job.
`Future<GetProjectResponse>`	`getProject(GetProjectRequest request, AsyncHandler<GetProjectRequest,GetProjectResponse> handler)`	Get a project by identifier.
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)`	Gets the status of the work request with the given ID.
`Future<ListModelsResponse>`	`listModels(ListModelsRequest request, AsyncHandler<ListModelsRequest,ListModelsResponse> handler)`	Returns a list of models in a compartment.
`Future<ListProjectsResponse>`	`listProjects(ListProjectsRequest request, AsyncHandler<ListProjectsRequest,ListProjectsResponse> handler)`	Returns a list of projects.
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)`	Returns a (paginated) list of errors for a given work request.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)`	Return a (paginated) list of logs for a given work request.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)`	Lists the work requests in a compartment.
`Future<PatchModelResponse>`	`patchModel(PatchModelRequest request, AsyncHandler<PatchModelRequest,PatchModelResponse> handler)`	Updates the model metadata only selected path parameter.
`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`.
`Future<RemoveModelLockResponse>`	`removeModelLock(RemoveModelLockRequest request, AsyncHandler<RemoveModelLockRequest,RemoveModelLockResponse> handler)`	Remove a lock from a resource.
`Future<RemoveProjectLockResponse>`	`removeProjectLock(RemoveProjectLockRequest request, AsyncHandler<RemoveProjectLockRequest,RemoveProjectLockResponse> handler)`	Remove a lock from a resource.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)`	Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)`	Sets the region to call (ex, ‘us-phoenix-1’).
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`Future<UpdateModelResponse>`	`updateModel(UpdateModelRequest request, AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)`	Updates the model metadata.
`Future<UpdateProjectResponse>`	`updateProject(UpdateProjectRequest request, AsyncHandler<UpdateProjectRequest,UpdateProjectResponse> handler)`	Update the project metadata.
`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.aidocument.AIServiceDocumentAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable
close

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for AIServiceDocument.
  - 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
  - AIServiceDocumentAsyncClient
```
@Deprecated
public AIServiceDocumentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - AIServiceDocumentAsyncClient
```
@Deprecated
public AIServiceDocumentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - AIServiceDocumentAsyncClient
```
@Deprecated
public AIServiceDocumentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - AIServiceDocumentAsyncClient
```
@Deprecated
public AIServiceDocumentAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - AIServiceDocumentAsyncClient
```
@Deprecated
public AIServiceDocumentAsyncClient(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 AIServiceDocumentAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - AIServiceDocumentAsyncClient
```
@Deprecated
public AIServiceDocumentAsyncClient(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 AIServiceDocumentAsyncClient.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)
  - AIServiceDocumentAsyncClient
```
@Deprecated
public AIServiceDocumentAsyncClient(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 AIServiceDocumentAsyncClient.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 AIServiceDocumentAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AIServiceDocumentAsync
    
    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 AIServiceDocumentAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: AIServiceDocumentAsync
    
    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 AIServiceDocumentAsync
    
    Parameters:
    
    regionId - The public region ID.
  - addModelLock
```
public Future<AddModelLockResponse> addModelLock(AddModelLockRequest request,
                                                 AsyncHandler<AddModelLockRequest,AddModelLockResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Adds a lock to a resource.
    
    Specified by:
    
    addModelLock in interface AIServiceDocumentAsync
    
    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.
  - addProjectLock
```
public Future<AddProjectLockResponse> addProjectLock(AddProjectLockRequest request,
                                                     AsyncHandler<AddProjectLockRequest,AddProjectLockResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Adds a lock to a resource.
    
    Specified by:
    
    addProjectLock in interface AIServiceDocumentAsync
    
    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.
  - analyzeDocument
```
public Future<AnalyzeDocumentResponse> analyzeDocument(AnalyzeDocumentRequest request,
                                                       AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Perform different types of document analysis.
    
    Specified by:
    
    analyzeDocument in interface AIServiceDocumentAsync
    
    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.
  - cancelProcessorJob
```
public Future<CancelProcessorJobResponse> cancelProcessorJob(CancelProcessorJobRequest request,
                                                             AsyncHandler<CancelProcessorJobRequest,CancelProcessorJobResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Cancel a processor job.
    
    Specified by:
    
    cancelProcessorJob in interface AIServiceDocumentAsync
    
    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.
  - cancelWorkRequest
```
public Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                           AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Cancel the work request with the given ID.
    
    Specified by:
    
    cancelWorkRequest in interface AIServiceDocumentAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeModelCompartment
```
public Future<ChangeModelCompartmentResponse> changeModelCompartment(ChangeModelCompartmentRequest request,
                                                                     AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Moves a model from one compartment to another.
    When provided, If-Match is checked against the ETag values of the resource.
    
    Specified by:
    
    changeModelCompartment in interface AIServiceDocumentAsync
    
    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.
  - changeProjectCompartment
```
public Future<ChangeProjectCompartmentResponse> changeProjectCompartment(ChangeProjectCompartmentRequest request,
                                                                         AsyncHandler<ChangeProjectCompartmentRequest,ChangeProjectCompartmentResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Move a project from one compartment to another.
    When provided, If-Match is checked against the ETag values of the resource.
    
    Specified by:
    
    changeProjectCompartment in interface AIServiceDocumentAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createModel
```
public Future<CreateModelResponse> createModel(CreateModelRequest request,
                                               AsyncHandler<CreateModelRequest,CreateModelResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Create a new model.
    
    Specified by:
    
    createModel in interface AIServiceDocumentAsync
    
    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.
  - createProcessorJob
```
public Future<CreateProcessorJobResponse> createProcessorJob(CreateProcessorJobRequest request,
                                                             AsyncHandler<CreateProcessorJobRequest,CreateProcessorJobResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Create a processor job for document analysis.
    
    Specified by:
    
    createProcessorJob in interface AIServiceDocumentAsync
    
    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.
  - createProject
```
public Future<CreateProjectResponse> createProject(CreateProjectRequest request,
                                                   AsyncHandler<CreateProjectRequest,CreateProjectResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Create a new project.
    
    Specified by:
    
    createProject in interface AIServiceDocumentAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteModel
```
public Future<DeleteModelResponse> deleteModel(DeleteModelRequest request,
                                               AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Delete a model by identifier.
    
    Specified by:
    
    deleteModel in interface AIServiceDocumentAsync
    
    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.
  - deleteProject
```
public Future<DeleteProjectResponse> deleteProject(DeleteProjectRequest request,
                                                   AsyncHandler<DeleteProjectRequest,DeleteProjectResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Delete a project by identifier.
    
    Specified by:
    
    deleteProject in interface AIServiceDocumentAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getModel
```
public Future<GetModelResponse> getModel(GetModelRequest request,
                                         AsyncHandler<GetModelRequest,GetModelResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Get a model by identifier.
    
    Specified by:
    
    getModel in interface AIServiceDocumentAsync
    
    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.
  - getProcessorJob
```
public Future<GetProcessorJobResponse> getProcessorJob(GetProcessorJobRequest request,
                                                       AsyncHandler<GetProcessorJobRequest,GetProcessorJobResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Get the details of a processor job.
    
    Specified by:
    
    getProcessorJob in interface AIServiceDocumentAsync
    
    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.
  - getProject
```
public Future<GetProjectResponse> getProject(GetProjectRequest request,
                                             AsyncHandler<GetProjectRequest,GetProjectResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Get a project by identifier.
    
    Specified by:
    
    getProject in interface AIServiceDocumentAsync
    
    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: AIServiceDocumentAsync
    
    Gets the status of the work request with the given ID.
    
    Specified by:
    
    getWorkRequest in interface AIServiceDocumentAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listModels
```
public Future<ListModelsResponse> listModels(ListModelsRequest request,
                                             AsyncHandler<ListModelsRequest,ListModelsResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Returns a list of models in a compartment.
    
    Specified by:
    
    listModels in interface AIServiceDocumentAsync
    
    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.
  - listProjects
```
public Future<ListProjectsResponse> listProjects(ListProjectsRequest request,
                                                 AsyncHandler<ListProjectsRequest,ListProjectsResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Returns a list of projects.
    
    Specified by:
    
    listProjects in interface AIServiceDocumentAsync
    
    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: AIServiceDocumentAsync
    
    Returns a (paginated) list of errors for a given work request.
    
    Specified by:
    
    listWorkRequestErrors in interface AIServiceDocumentAsync
    
    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: AIServiceDocumentAsync
    
    Return a (paginated) list of logs for a given work request.
    
    Specified by:
    
    listWorkRequestLogs in interface AIServiceDocumentAsync
    
    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: AIServiceDocumentAsync
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface AIServiceDocumentAsync
    
    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.
  - patchModel
```
public Future<PatchModelResponse> patchModel(PatchModelRequest request,
                                             AsyncHandler<PatchModelRequest,PatchModelResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Updates the model metadata only selected path parameter.
    
    Specified by:
    
    patchModel in interface AIServiceDocumentAsync
    
    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.
  - removeModelLock
```
public Future<RemoveModelLockResponse> removeModelLock(RemoveModelLockRequest request,
                                                       AsyncHandler<RemoveModelLockRequest,RemoveModelLockResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Remove a lock from a resource.
    
    Specified by:
    
    removeModelLock in interface AIServiceDocumentAsync
    
    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.
  - removeProjectLock
```
public Future<RemoveProjectLockResponse> removeProjectLock(RemoveProjectLockRequest request,
                                                           AsyncHandler<RemoveProjectLockRequest,RemoveProjectLockResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Remove a lock from a resource.
    
    Specified by:
    
    removeProjectLock in interface AIServiceDocumentAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateModel
```
public Future<UpdateModelResponse> updateModel(UpdateModelRequest request,
                                               AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Updates the model metadata.
    
    Specified by:
    
    updateModel in interface AIServiceDocumentAsync
    
    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.
  - updateProject
```
public Future<UpdateProjectResponse> updateProject(UpdateProjectRequest request,
                                                   AsyncHandler<UpdateProjectRequest,UpdateProjectResponse> handler)
```
    Description copied from interface: AIServiceDocumentAsync
    
    Update the project metadata.
    
    Specified by:
    
    updateProject in interface AIServiceDocumentAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
    The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only.
    This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)
```

Class AIServiceDocumentAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.aidocument.AIServiceDocumentAsync

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

AIServiceDocumentAsyncClient

AIServiceDocumentAsyncClient

AIServiceDocumentAsyncClient

AIServiceDocumentAsyncClient

AIServiceDocumentAsyncClient

AIServiceDocumentAsyncClient

AIServiceDocumentAsyncClient

Method Detail

builder

setRegion

setRegion

addModelLock

addProjectLock

analyzeDocument

cancelProcessorJob

cancelWorkRequest

changeModelCompartment

changeProjectCompartment

createModel

createProcessorJob

createProject

deleteModel

deleteProject

getModel

getProcessorJob

getProject

getWorkRequest

listModels

listProjects

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

patchModel

removeModelLock

removeProjectLock

updateModel

updateProject

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient

clientCall