Interface AIServiceVision
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
AIServiceVisionClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20220125") public interface AIServiceVision extends AutoCloseable
Using Vision, you can upload images to detect and classify objects in them.If you have lots of images, you can process them in batch using asynchronous API endpoints. Vision’s features are thematically split between Document AI for document-centric images, and Image Analysis for object and scene-based images. Pretrained models and custom models are supported. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
-
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 service.
-
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 callsetEndpoint
.- 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
-
analyzeDocument
AnalyzeDocumentResponse analyzeDocument(AnalyzeDocumentRequest request)
Perform different types of image analysis.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/AnalyzeDocumentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AnalyzeDocument API.
-
analyzeImage
AnalyzeImageResponse analyzeImage(AnalyzeImageRequest request)
Perform different types of image analysis.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/AnalyzeImageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AnalyzeImage API.
-
cancelDocumentJob
CancelDocumentJobResponse cancelDocumentJob(CancelDocumentJobRequest request)
Cancel a document batch job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CancelDocumentJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelDocumentJob API.
-
cancelImageJob
CancelImageJobResponse cancelImageJob(CancelImageJobRequest request)
Cancel an image batch job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CancelImageJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelImageJob API.
-
cancelVideoJob
CancelVideoJobResponse cancelVideoJob(CancelVideoJobRequest request)
Cancel a video analysis job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CancelVideoJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelVideoJob API.
-
cancelWorkRequest
CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Cancel the work request with the given ID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CancelWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelWorkRequest API.
-
changeModelCompartment
ChangeModelCompartmentResponse changeModelCompartment(ChangeModelCompartmentRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ChangeModelCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeModelCompartment API.
-
changeProjectCompartment
ChangeProjectCompartmentResponse changeProjectCompartment(ChangeProjectCompartmentRequest request)
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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ChangeProjectCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeProjectCompartment API.
-
changeStreamGroupCompartment
ChangeStreamGroupCompartmentResponse changeStreamGroupCompartment(ChangeStreamGroupCompartmentRequest request)
Move a streamGroup 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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ChangeStreamGroupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeStreamGroupCompartment API.
-
changeStreamJobCompartment
ChangeStreamJobCompartmentResponse changeStreamJobCompartment(ChangeStreamJobCompartmentRequest request)
Move a streamJob 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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ChangeStreamJobCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeStreamJobCompartment API.
-
changeStreamSourceCompartment
ChangeStreamSourceCompartmentResponse changeStreamSourceCompartment(ChangeStreamSourceCompartmentRequest request)
Move a streamSource 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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ChangeStreamSourceCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeStreamSourceCompartment API.
-
changeVisionPrivateEndpointCompartment
ChangeVisionPrivateEndpointCompartmentResponse changeVisionPrivateEndpointCompartment(ChangeVisionPrivateEndpointCompartmentRequest request)
Move a visionPrivateEndpoint 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- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ChangeVisionPrivateEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeVisionPrivateEndpointCompartment API.
-
createDocumentJob
CreateDocumentJobResponse createDocumentJob(CreateDocumentJobRequest request)
Create a document analysis batch job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateDocumentJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDocumentJob API.
-
createImageJob
CreateImageJobResponse createImageJob(CreateImageJobRequest request)
Create an image analysis batch job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateImageJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateImageJob API.
-
createModel
CreateModelResponse createModel(CreateModelRequest request)
Create a new model.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateModel API.
-
createProject
CreateProjectResponse createProject(CreateProjectRequest request)
Create a new project.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateProject API.
-
createStreamGroup
CreateStreamGroupResponse createStreamGroup(CreateStreamGroupRequest request)
Registration of new streamGroup- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateStreamGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateStreamGroup API.
-
createStreamJob
CreateStreamJobResponse createStreamJob(CreateStreamJobRequest request)
Create a stream analysis job with given inputs and features.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateStreamJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateStreamJob API.
-
createStreamSource
CreateStreamSourceResponse createStreamSource(CreateStreamSourceRequest request)
Registration of new streamSource- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateStreamSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateStreamSource API.
-
createVideoJob
CreateVideoJobResponse createVideoJob(CreateVideoJobRequest request)
Create a video analysis job with given inputs and features.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateVideoJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVideoJob API.
-
createVisionPrivateEndpoint
CreateVisionPrivateEndpointResponse createVisionPrivateEndpoint(CreateVisionPrivateEndpointRequest request)
Create a new visionPrivateEndpoint.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/CreateVisionPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateVisionPrivateEndpoint API.
-
deleteModel
DeleteModelResponse deleteModel(DeleteModelRequest request)
Delete a model by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/DeleteModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteModel API.
-
deleteProject
DeleteProjectResponse deleteProject(DeleteProjectRequest request)
Delete a project by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/DeleteProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteProject API.
-
deleteStreamGroup
DeleteStreamGroupResponse deleteStreamGroup(DeleteStreamGroupRequest request)
Delete a streamGroup- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/DeleteStreamGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteStreamGroup API.
-
deleteStreamJob
DeleteStreamJobResponse deleteStreamJob(DeleteStreamJobRequest request)
Get details of a stream analysis job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/DeleteStreamJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteStreamJob API.
-
deleteStreamSource
DeleteStreamSourceResponse deleteStreamSource(DeleteStreamSourceRequest request)
Delete a streamSource- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/DeleteStreamSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteStreamSource API.
-
deleteVisionPrivateEndpoint
DeleteVisionPrivateEndpointResponse deleteVisionPrivateEndpoint(DeleteVisionPrivateEndpointRequest request)
Delete a visionPrivateEndpoint by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/DeleteVisionPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteVisionPrivateEndpoint API.
-
getDocumentJob
GetDocumentJobResponse getDocumentJob(GetDocumentJobRequest request)
Get details of a document batch job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetDocumentJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDocumentJob API.
-
getImageJob
GetImageJobResponse getImageJob(GetImageJobRequest request)
Get details of an image batch job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetImageJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetImageJob API.
-
getModel
GetModelResponse getModel(GetModelRequest request)
Get a model by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetModel API.
-
getProject
GetProjectResponse getProject(GetProjectRequest request)
Get a project by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetProject API.
-
getStreamGroup
GetStreamGroupResponse getStreamGroup(GetStreamGroupRequest request)
Get a streamGroup- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetStreamGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStreamGroup API.
-
getStreamJob
GetStreamJobResponse getStreamJob(GetStreamJobRequest request)
Get details of a stream analysis job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetStreamJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStreamJob API.
-
getStreamSource
GetStreamSourceResponse getStreamSource(GetStreamSourceRequest request)
Get a streamSource- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetStreamSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStreamSource API.
-
getVideoJob
GetVideoJobResponse getVideoJob(GetVideoJobRequest request)
Get details of a video analysis job.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetVideoJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVideoJob API.
-
getVisionPrivateEndpoint
GetVisionPrivateEndpointResponse getVisionPrivateEndpoint(GetVisionPrivateEndpointRequest request)
Get a visionPrivateEndpoint by identifier.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetVisionPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetVisionPrivateEndpoint API.
-
getWorkRequest
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
-
listModels
ListModelsResponse listModels(ListModelsRequest request)
Returns a list of models in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListModelsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListModels API.
-
listProjects
ListProjectsResponse listProjects(ListProjectsRequest request)
Returns a list of projects.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListProjectsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProjects API.
-
listStreamGroups
ListStreamGroupsResponse listStreamGroups(ListStreamGroupsRequest request)
Gets a list of the streamGroups in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListStreamGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStreamGroups API.
-
listStreamJobs
ListStreamJobsResponse listStreamJobs(ListStreamJobsRequest request)
Get list of stream jobs- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListStreamJobsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStreamJobs API.
-
listStreamSources
ListStreamSourcesResponse listStreamSources(ListStreamSourcesRequest request)
Gets a list of the streamSources in the specified compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListStreamSourcesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStreamSources API.
-
listVisionPrivateEndpoints
ListVisionPrivateEndpointsResponse listVisionPrivateEndpoints(ListVisionPrivateEndpointsRequest request)
Returns a list of visionPrivateEndpoints.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListVisionPrivateEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVisionPrivateEndpoints API.
-
listWorkRequestErrors
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a (paginated) list of errors for a given work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.
-
listWorkRequestLogs
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.
-
listWorkRequests
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
startStreamJob
StartStreamJobResponse startStreamJob(StartStreamJobRequest request)
End a stream analysis Run.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/StartStreamJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartStreamJob API.
-
stopStreamJob
StopStreamJobResponse stopStreamJob(StopStreamJobRequest request)
End a stream analysis Run.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/StopStreamJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopStreamJob API.
-
updateModel
UpdateModelResponse updateModel(UpdateModelRequest request)
Updates the model metadata.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/UpdateModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateModel API.
-
updateProject
UpdateProjectResponse updateProject(UpdateProjectRequest request)
Update the project metadata.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/UpdateProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateProject API.
-
updateStreamGroup
UpdateStreamGroupResponse updateStreamGroup(UpdateStreamGroupRequest request)
Update a streamGroup- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/UpdateStreamGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateStreamGroup API.
-
updateStreamJob
UpdateStreamJobResponse updateStreamJob(UpdateStreamJobRequest request)
Create a stream analysis job with given inputs and features.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/UpdateStreamJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateStreamJob API.
-
updateStreamSource
UpdateStreamSourceResponse updateStreamSource(UpdateStreamSourceRequest request)
Update a streamSource- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/UpdateStreamSourceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateStreamSource API.
-
updateVisionPrivateEndpoint
UpdateVisionPrivateEndpointResponse updateVisionPrivateEndpoint(UpdateVisionPrivateEndpointRequest request)
Update the visionPrivateEndpoint metadata.- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
- Throws:
BmcException
- when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.72.1/aivision/UpdateVisionPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateVisionPrivateEndpoint API.
-
getWaiters
AIServiceVisionWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
AIServiceVisionPaginators getPaginators()
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.- Returns:
- The service paginators.
-
-