java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.aidocument.AIServiceDocumentClient

All Implemented Interfaces:: AIServiceDocument, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221109")
public class AIServiceDocumentClient
extends BaseSyncClient
implements AIServiceDocument

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AIServiceDocumentClient.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
`AIServiceDocumentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`AIServiceDocumentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`AIServiceDocumentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`AIServiceDocumentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`AIServiceDocumentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)`	Deprecated. Use the `builder` instead.
`AIServiceDocumentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`AIServiceDocumentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`AIServiceDocumentClient(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
`AddModelLockResponse`	`addModelLock(AddModelLockRequest request)`	Adds a lock to a resource.
`AddProjectLockResponse`	`addProjectLock(AddProjectLockRequest request)`	Adds a lock to a resource.
`AnalyzeDocumentResponse`	`analyzeDocument(AnalyzeDocumentRequest request)`	Perform different types of document analysis.
`static AIServiceDocumentClient.Builder`	`builder()`	Create a builder for this client.
`CancelProcessorJobResponse`	`cancelProcessorJob(CancelProcessorJobRequest request)`	Cancel a processor job.
`CancelWorkRequestResponse`	`cancelWorkRequest(CancelWorkRequestRequest request)`	Cancel the work request with the given ID.
`ChangeModelCompartmentResponse`	`changeModelCompartment(ChangeModelCompartmentRequest request)`	Moves a model from one compartment to another.
`ChangeProjectCompartmentResponse`	`changeProjectCompartment(ChangeProjectCompartmentRequest request)`	Move a project from one compartment to another.
`void`	`close()`
`CreateModelResponse`	`createModel(CreateModelRequest request)`	Create a new model.
`CreateProcessorJobResponse`	`createProcessorJob(CreateProcessorJobRequest request)`	Create a processor job for document analysis.
`CreateProjectResponse`	`createProject(CreateProjectRequest request)`	Create a new project.
`DeleteModelResponse`	`deleteModel(DeleteModelRequest request)`	Delete a model by identifier.
`DeleteProjectResponse`	`deleteProject(DeleteProjectRequest request)`	Delete a project by identifier.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`	Get the endpoint of the client.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`GetModelResponse`	`getModel(GetModelRequest request)`	Get a model by identifier.
`GetModelTypeResponse`	`getModelType(GetModelTypeRequest request)`	Gets model capabilities
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`AIServiceDocumentPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetProcessorJobResponse`	`getProcessorJob(GetProcessorJobRequest request)`	Get the details of a processor job.
`GetProjectResponse`	`getProject(GetProjectRequest request)`	Get a project by identifier.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`AIServiceDocumentWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Gets the status of the work request with the given ID.
`ListModelsResponse`	`listModels(ListModelsRequest request)`	Returns a list of models in a compartment.
`ListProjectsResponse`	`listProjects(ListProjectsRequest request)`	Returns a list of projects.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Returns a (paginated) list of errors for a given work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Return a (paginated) list of logs for a given work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists the work requests in a compartment.
`PatchModelResponse`	`patchModel(PatchModelRequest request)`	Updates the model metadata only selected path parameter.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`RemoveModelLockResponse`	`removeModelLock(RemoveModelLockRequest request)`	Remove a lock from a resource.
`RemoveProjectLockResponse`	`removeProjectLock(RemoveProjectLockRequest request)`	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’).
`UpdateModelResponse`	`updateModel(UpdateModelRequest request)`	Updates the model metadata.
`UpdateProjectResponse`	`updateProject(UpdateProjectRequest request)`	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 com.oracle.bmc.http.internal.BaseSyncClient
clientCall

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.AIServiceDocument
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
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(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 AIServiceDocumentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(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 AIServiceDocumentClient.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)
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(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 AIServiceDocumentClient.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
  - AIServiceDocumentClient
```
@Deprecated
public AIServiceDocumentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint,
                               ExecutorService executorService)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see AIServiceDocumentClient.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
    
    executorService - AIServiceDocumentClient.Builder.executorService
- Method Detail
  - builder
```
public static AIServiceDocumentClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AIServiceDocument
    
    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 AIServiceDocument
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: AIServiceDocument
    
    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 AIServiceDocument
    
    Parameters:
    
    regionId - The public region ID.
  - addModelLock
```
public AddModelLockResponse addModelLock(AddModelLockRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Adds a lock to a resource.
    
    Specified by:
    
    addModelLock in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - addProjectLock
```
public AddProjectLockResponse addProjectLock(AddProjectLockRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Adds a lock to a resource.
    
    Specified by:
    
    addProjectLock in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - analyzeDocument
```
public AnalyzeDocumentResponse analyzeDocument(AnalyzeDocumentRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Perform different types of document analysis.
    
    Specified by:
    
    analyzeDocument in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - cancelProcessorJob
```
public CancelProcessorJobResponse cancelProcessorJob(CancelProcessorJobRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Cancel a processor job.
    
    Specified by:
    
    cancelProcessorJob in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - cancelWorkRequest
```
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Cancel the work request with the given ID.
    
    Specified by:
    
    cancelWorkRequest in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeModelCompartment
```
public ChangeModelCompartmentResponse changeModelCompartment(ChangeModelCompartmentRequest request)
```
    Description copied from interface: AIServiceDocument
    
    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 AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeProjectCompartment
```
public ChangeProjectCompartmentResponse changeProjectCompartment(ChangeProjectCompartmentRequest request)
```
    Description copied from interface: AIServiceDocument
    
    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 AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createModel
```
public CreateModelResponse createModel(CreateModelRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Create a new model.
    
    Specified by:
    
    createModel in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createProcessorJob
```
public CreateProcessorJobResponse createProcessorJob(CreateProcessorJobRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Create a processor job for document analysis.
    
    Specified by:
    
    createProcessorJob in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createProject
```
public CreateProjectResponse createProject(CreateProjectRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Create a new project.
    
    Specified by:
    
    createProject in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteModel
```
public DeleteModelResponse deleteModel(DeleteModelRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Delete a model by identifier.
    
    Specified by:
    
    deleteModel in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteProject
```
public DeleteProjectResponse deleteProject(DeleteProjectRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Delete a project by identifier.
    
    Specified by:
    
    deleteProject in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getModel
```
public GetModelResponse getModel(GetModelRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Get a model by identifier.
    
    Specified by:
    
    getModel in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getModelType
```
public GetModelTypeResponse getModelType(GetModelTypeRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Gets model capabilities
    
    Specified by:
    
    getModelType in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getProcessorJob
```
public GetProcessorJobResponse getProcessorJob(GetProcessorJobRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Get the details of a processor job.
    
    Specified by:
    
    getProcessorJob in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getProject
```
public GetProjectResponse getProject(GetProjectRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Get a project by identifier.
    
    Specified by:
    
    getProject in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Gets the status of the work request with the given ID.
    
    Specified by:
    
    getWorkRequest in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listModels
```
public ListModelsResponse listModels(ListModelsRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Returns a list of models in a compartment.
    
    Specified by:
    
    listModels in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listProjects
```
public ListProjectsResponse listProjects(ListProjectsRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Returns a list of projects.
    
    Specified by:
    
    listProjects in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Returns a (paginated) list of errors for a given work request.
    
    Specified by:
    
    listWorkRequestErrors in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Return a (paginated) list of logs for a given work request.
    
    Specified by:
    
    listWorkRequestLogs in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - patchModel
```
public PatchModelResponse patchModel(PatchModelRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Updates the model metadata only selected path parameter.
    
    Specified by:
    
    patchModel in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeModelLock
```
public RemoveModelLockResponse removeModelLock(RemoveModelLockRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Remove a lock from a resource.
    
    Specified by:
    
    removeModelLock in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - removeProjectLock
```
public RemoveProjectLockResponse removeProjectLock(RemoveProjectLockRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Remove a lock from a resource.
    
    Specified by:
    
    removeProjectLock in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateModel
```
public UpdateModelResponse updateModel(UpdateModelRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Updates the model metadata.
    
    Specified by:
    
    updateModel in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateProject
```
public UpdateProjectResponse updateProject(UpdateProjectRequest request)
```
    Description copied from interface: AIServiceDocument
    
    Update the project metadata.
    
    Specified by:
    
    updateProject in interface AIServiceDocument
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public AIServiceDocumentWaiters getWaiters()
```
    Description copied from interface: AIServiceDocument
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface AIServiceDocument
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public AIServiceDocumentPaginators getPaginators()
```
    Description copied from interface: AIServiceDocument
    
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
    These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Specified by:
    
    getPaginators in interface AIServiceDocument
    
    Returns:
    
    The service paginators.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - 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
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - 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()
```

Class AIServiceDocumentClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

AIServiceDocumentClient

AIServiceDocumentClient

AIServiceDocumentClient

AIServiceDocumentClient

AIServiceDocumentClient

AIServiceDocumentClient

AIServiceDocumentClient

AIServiceDocumentClient

Method Detail

builder

setRegion

setRegion

addModelLock

addProjectLock

analyzeDocument

cancelProcessorJob

cancelWorkRequest

changeModelCompartment

changeProjectCompartment

createModel

createProcessorJob

createProject

deleteModel

deleteProject

getModel

getModelType

getProcessorJob

getProject

getWorkRequest

listModels

listProjects

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

patchModel

removeModelLock

removeProjectLock

updateModel

updateProject

getWaiters

getPaginators

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient