AIServiceDocumentAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AIServiceDocumentAsyncClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221109")
public interface AIServiceDocumentAsync
extends AutoCloseable
```
Document AI helps customers perform various analysis on their documents. If a customer has lots of documents, they can process them in batch using asynchronous API endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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.
`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.
`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`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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`	`refreshClient()` Rebuilds the client from scratch.
`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)` Sets the endpoint to call (ex, https://www.example.com).
`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<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 realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - addModelLock
```
Future<AddModelLockResponse> addModelLock(AddModelLockRequest request,
                                          AsyncHandler<AddModelLockRequest,AddModelLockResponse> handler)
```
    Adds a lock to a resource.
    
    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
```
Future<AddProjectLockResponse> addProjectLock(AddProjectLockRequest request,
                                              AsyncHandler<AddProjectLockRequest,AddProjectLockResponse> handler)
```
    Adds a lock to a resource.
    
    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
```
Future<AnalyzeDocumentResponse> analyzeDocument(AnalyzeDocumentRequest request,
                                                AsyncHandler<AnalyzeDocumentRequest,AnalyzeDocumentResponse> handler)
```
    Perform different types of document analysis.
    
    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
```
Future<CancelProcessorJobResponse> cancelProcessorJob(CancelProcessorJobRequest request,
                                                      AsyncHandler<CancelProcessorJobRequest,CancelProcessorJobResponse> handler)
```
    Cancel a processor job.
    
    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
```
Future<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request,
                                                    AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
```
    Cancel the work request with the given ID.
    
    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
```
Future<ChangeModelCompartmentResponse> changeModelCompartment(ChangeModelCompartmentRequest request,
                                                              AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)
```
    Moves a model from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
    
    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
```
Future<ChangeProjectCompartmentResponse> changeProjectCompartment(ChangeProjectCompartmentRequest request,
                                                                  AsyncHandler<ChangeProjectCompartmentRequest,ChangeProjectCompartmentResponse> handler)
```
    Move a project from one compartment to another. When provided, If-Match is checked against the ETag values of the resource.
    
    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
```
Future<CreateModelResponse> createModel(CreateModelRequest request,
                                        AsyncHandler<CreateModelRequest,CreateModelResponse> handler)
```
    Create a new model.
    
    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
```
Future<CreateProcessorJobResponse> createProcessorJob(CreateProcessorJobRequest request,
                                                      AsyncHandler<CreateProcessorJobRequest,CreateProcessorJobResponse> handler)
```
    Create a processor job for document analysis.
    
    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
```
Future<CreateProjectResponse> createProject(CreateProjectRequest request,
                                            AsyncHandler<CreateProjectRequest,CreateProjectResponse> handler)
```
    Create a new project.
    
    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
```
Future<DeleteModelResponse> deleteModel(DeleteModelRequest request,
                                        AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)
```
    Delete a model by identifier.
    
    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
```
Future<DeleteProjectResponse> deleteProject(DeleteProjectRequest request,
                                            AsyncHandler<DeleteProjectRequest,DeleteProjectResponse> handler)
```
    Delete a project by identifier.
    
    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
```
Future<GetModelResponse> getModel(GetModelRequest request,
                                  AsyncHandler<GetModelRequest,GetModelResponse> handler)
```
    Get a model by identifier.
    
    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
```
Future<GetProcessorJobResponse> getProcessorJob(GetProcessorJobRequest request,
                                                AsyncHandler<GetProcessorJobRequest,GetProcessorJobResponse> handler)
```
    Get the details of a processor job.
    
    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
```
Future<GetProjectResponse> getProject(GetProjectRequest request,
                                      AsyncHandler<GetProjectRequest,GetProjectResponse> handler)
```
    Get a project by identifier.
    
    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
```
Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Gets the status of the work request with the given ID.
    
    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
```
Future<ListModelsResponse> listModels(ListModelsRequest request,
                                      AsyncHandler<ListModelsRequest,ListModelsResponse> handler)
```
    Returns a list of models in a compartment.
    
    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
```
Future<ListProjectsResponse> listProjects(ListProjectsRequest request,
                                          AsyncHandler<ListProjectsRequest,ListProjectsResponse> handler)
```
    Returns a list of projects.
    
    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
```
Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Returns a (paginated) list of errors for a given work request.
    
    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
```
Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Return a (paginated) list of logs for a given work request.
    
    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
```
Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    Lists the work requests in a compartment.
    
    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
```
Future<PatchModelResponse> patchModel(PatchModelRequest request,
                                      AsyncHandler<PatchModelRequest,PatchModelResponse> handler)
```
    Updates the model metadata only selected path parameter.
    
    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
```
Future<RemoveModelLockResponse> removeModelLock(RemoveModelLockRequest request,
                                                AsyncHandler<RemoveModelLockRequest,RemoveModelLockResponse> handler)
```
    Remove a lock from a resource.
    
    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
```
Future<RemoveProjectLockResponse> removeProjectLock(RemoveProjectLockRequest request,
                                                    AsyncHandler<RemoveProjectLockRequest,RemoveProjectLockResponse> handler)
```
    Remove a lock from a resource.
    
    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
```
Future<UpdateModelResponse> updateModel(UpdateModelRequest request,
                                        AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)
```
    Updates the model metadata.
    
    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
```
Future<UpdateProjectResponse> updateProject(UpdateProjectRequest request,
                                            AsyncHandler<UpdateProjectRequest,UpdateProjectResponse> handler)
```
    Update the project metadata.
    
    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.

Interface AIServiceDocumentAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

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