Package com.oracle.bmc.aivision

Class AIServiceVisionClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.aivision.AIServiceVisionClient

All Implemented Interfaces:

AIServiceVision, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220125")
public class AIServiceVisionClient
extends BaseSyncClient
implements AIServiceVision

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AIServiceVisionClient.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 AIServiceVision.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AnalyzeDocumentResponse	analyzeDocument(AnalyzeDocumentRequest request)	Perform different types of image analysis.
AnalyzeImageResponse	analyzeImage(AnalyzeImageRequest request)	Perform different types of image analysis.
static AIServiceVisionClient.Builder	builder()	Create a builder for this client.
CancelDocumentJobResponse	cancelDocumentJob(CancelDocumentJobRequest request)	Cancel a document batch job.
CancelImageJobResponse	cancelImageJob(CancelImageJobRequest request)	Cancel an image batch job.
CancelVideoJobResponse	cancelVideoJob(CancelVideoJobRequest request)	Cancel a video analysis 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()
CreateDocumentJobResponse	createDocumentJob(CreateDocumentJobRequest request)	Create a document analysis batch job.
CreateImageJobResponse	createImageJob(CreateImageJobRequest request)	Create an image analysis batch job.
CreateModelResponse	createModel(CreateModelRequest request)	Create a new model.
CreateProjectResponse	createProject(CreateProjectRequest request)	Create a new project.
CreateVideoJobResponse	createVideoJob(CreateVideoJobRequest request)	Create a video analysis job with given inputs and features.
DeleteModelResponse	deleteModel(DeleteModelRequest request)	Delete a model by identifier.
DeleteProjectResponse	deleteProject(DeleteProjectRequest request)	Delete a project by identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
GetDocumentJobResponse	getDocumentJob(GetDocumentJobRequest request)	Get details of a document batch job.
String	getEndpoint()
GetImageJobResponse	getImageJob(GetImageJobRequest request)	Get details of an image batch job.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetModelResponse	getModel(GetModelRequest request)	Get a model by identifier.
AIServiceVisionPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetProjectResponse	getProject(GetProjectRequest request)	Get a project by identifier.
GetVideoJobResponse	getVideoJob(GetVideoJobRequest request)	Get details of a video analysis job.
AIServiceVisionWaiters	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.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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.aivision.AIServiceVision

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for AIServiceVision.

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

AIServiceVisionClient

@Deprecated
public AIServiceVisionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

AIServiceVisionClient

@Deprecated
public AIServiceVisionClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

AIServiceVisionClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

AIServiceVisionClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AIServiceVisionClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AIServiceVisionClient

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

AIServiceVisionClient

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

AIServiceVisionClient

@Deprecated
public AIServiceVisionClient(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 AIServiceVisionClient.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 - AIServiceVisionClient.Builder.executorService

Method Detail

builder

public static AIServiceVisionClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: AIServiceVision

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 AIServiceVision

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AIServiceVision

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 AIServiceVision

Parameters:

regionId - The public region ID.

analyzeDocument

public AnalyzeDocumentResponse analyzeDocument(AnalyzeDocumentRequest request)

Description copied from interface: AIServiceVision

Perform different types of image analysis.

Specified by:

analyzeDocument in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

analyzeImage

public AnalyzeImageResponse analyzeImage(AnalyzeImageRequest request)

Description copied from interface: AIServiceVision

Perform different types of image analysis.

Specified by:

analyzeImage in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelDocumentJob

public CancelDocumentJobResponse cancelDocumentJob(CancelDocumentJobRequest request)

Description copied from interface: AIServiceVision

Cancel a document batch job.

Specified by:

cancelDocumentJob in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelImageJob

public CancelImageJobResponse cancelImageJob(CancelImageJobRequest request)

Description copied from interface: AIServiceVision

Cancel an image batch job.

Specified by:

cancelImageJob in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelVideoJob

public CancelVideoJobResponse cancelVideoJob(CancelVideoJobRequest request)

Description copied from interface: AIServiceVision

Cancel a video analysis job.

Specified by:

cancelVideoJob in interface AIServiceVision

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

Cancel the work request with the given ID.

Specified by:

cancelWorkRequest in interface AIServiceVision

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

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 AIServiceVision

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

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 AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDocumentJob

public CreateDocumentJobResponse createDocumentJob(CreateDocumentJobRequest request)

Description copied from interface: AIServiceVision

Create a document analysis batch job.

Specified by:

createDocumentJob in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createImageJob

public CreateImageJobResponse createImageJob(CreateImageJobRequest request)

Description copied from interface: AIServiceVision

Create an image analysis batch job.

Specified by:

createImageJob in interface AIServiceVision

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

Create a new model.

Specified by:

createModel in interface AIServiceVision

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

Create a new project.

Specified by:

createProject in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVideoJob

public CreateVideoJobResponse createVideoJob(CreateVideoJobRequest request)

Description copied from interface: AIServiceVision

Create a video analysis job with given inputs and features.

Specified by:

createVideoJob in interface AIServiceVision

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

Delete a model by identifier.

Specified by:

deleteModel in interface AIServiceVision

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

Delete a project by identifier.

Specified by:

deleteProject in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDocumentJob

public GetDocumentJobResponse getDocumentJob(GetDocumentJobRequest request)

Description copied from interface: AIServiceVision

Get details of a document batch job.

Specified by:

getDocumentJob in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getImageJob

public GetImageJobResponse getImageJob(GetImageJobRequest request)

Description copied from interface: AIServiceVision

Get details of an image batch job.

Specified by:

getImageJob in interface AIServiceVision

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

Get a model by identifier.

Specified by:

getModel in interface AIServiceVision

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

Get a project by identifier.

Specified by:

getProject in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVideoJob

public GetVideoJobResponse getVideoJob(GetVideoJobRequest request)

Description copied from interface: AIServiceVision

Get details of a video analysis job.

Specified by:

getVideoJob in interface AIServiceVision

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

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface AIServiceVision

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

Returns a list of models in a compartment.

Specified by:

listModels in interface AIServiceVision

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

Returns a list of projects.

Specified by:

listProjects in interface AIServiceVision

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

Returns a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface AIServiceVision

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

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface AIServiceVision

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

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface AIServiceVision

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

Updates the model metadata.

Specified by:

updateModel in interface AIServiceVision

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

Update the project metadata.

Specified by:

updateProject in interface AIServiceVision

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public AIServiceVisionWaiters getWaiters()

Description copied from interface: AIServiceVision

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface AIServiceVision

Returns:

The service waiters.

getPaginators

public AIServiceVisionPaginators getPaginators()

Description copied from interface: AIServiceVision

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 AIServiceVision

Returns:

The service paginators.

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()