com.oracle.bmc.datalabelingservicedataplane

Interface DataLabeling

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DataLabelingClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public interface DataLabeling
extends AutoCloseable

Use Data Labeling API to create Annotations on Images, Texts & Documents, and generate snapshots. 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

Modifier and Type	Method and Description
CreateAnnotationResponse	createAnnotation(CreateAnnotationRequest request) Creates an annotation.
CreateRecordResponse	createRecord(CreateRecordRequest request) Creates a record.
DeleteAnnotationResponse	deleteAnnotation(DeleteAnnotationRequest request) It deletes an annotation resource by identifier.
DeleteRecordResponse	deleteRecord(DeleteRecordRequest request) Deletes a record resource by identifier.
GetAnnotationResponse	getAnnotation(GetAnnotationRequest request) Gets an annotation.
GetDatasetResponse	getDataset(GetDatasetRequest request) Gets a dataset by identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
DataLabelingPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRecordResponse	getRecord(GetRecordRequest request) Gets a record.
GetRecordContentResponse	getRecordContent(GetRecordContentRequest request) Retrieves the content of the record from the dataset source.
GetRecordPreviewContentResponse	getRecordPreviewContent(GetRecordPreviewContentRequest request) Retrieves the preview of the record content from the dataset source.
DataLabelingWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListAnnotationsResponse	listAnnotations(ListAnnotationsRequest request) Returns a list of annotations.
ListRecordsResponse	listRecords(ListRecordsRequest request) The list of records in the specified compartment.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
SummarizeAnnotationAnalyticsResponse	summarizeAnnotationAnalytics(SummarizeAnnotationAnalyticsRequest request) Summarize the annotations created for a given dataset.
SummarizeRecordAnalyticsResponse	summarizeRecordAnalytics(SummarizeRecordAnalyticsRequest request) Summarize the records created for a given dataset.
UpdateAnnotationResponse	updateAnnotation(UpdateAnnotationRequest request) Updates an annotation.
UpdateRecordResponse	updateRecord(UpdateRecordRequest request) Updates a record.

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 call setEndpoint.

Parameters:

regionId - The public region ID.

createAnnotation

CreateAnnotationResponse createAnnotation(CreateAnnotationRequest request)

Creates an annotation.

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_Retries

Example: Click here to see how to use CreateAnnotation API.

createRecord

CreateRecordResponse createRecord(CreateRecordRequest request)

Creates a record.

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_Retries

Example: Click here to see how to use CreateRecord API.

deleteAnnotation

DeleteAnnotationResponse deleteAnnotation(DeleteAnnotationRequest request)

It deletes an annotation resource 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_Retries

Example: Click here to see how to use DeleteAnnotation API.

deleteRecord

DeleteRecordResponse deleteRecord(DeleteRecordRequest request)

Deletes a record resource 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_Retries

Example: Click here to see how to use DeleteRecord API.

getAnnotation

GetAnnotationResponse getAnnotation(GetAnnotationRequest request)

Gets an annotation.

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_Retries

Example: Click here to see how to use GetAnnotation API.

getDataset

GetDatasetResponse getDataset(GetDatasetRequest request)

Gets a dataset 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_Retries

Example: Click here to see how to use GetDataset API.

getRecord

GetRecordResponse getRecord(GetRecordRequest request)

Gets a record.

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_Retries

Example: Click here to see how to use GetRecord API.

getRecordContent

GetRecordContentResponse getRecordContent(GetRecordContentRequest request)

Retrieves the content of the record from the dataset source.

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_Retries

Example: Click here to see how to use GetRecordContent API.

getRecordPreviewContent

GetRecordPreviewContentResponse getRecordPreviewContent(GetRecordPreviewContentRequest request)

Retrieves the preview of the record content from the dataset source.

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_Retries

Example: Click here to see how to use GetRecordPreviewContent API.

listAnnotations

ListAnnotationsResponse listAnnotations(ListAnnotationsRequest request)

Returns a list of annotations.

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_Retries

Example: Click here to see how to use ListAnnotations API.

listRecords

ListRecordsResponse listRecords(ListRecordsRequest request)

The list of records 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_Retries

Example: Click here to see how to use ListRecords API.

summarizeAnnotationAnalytics

SummarizeAnnotationAnalyticsResponse summarizeAnnotationAnalytics(SummarizeAnnotationAnalyticsRequest request)

Summarize the annotations created for a given dataset.

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_Retries

Example: Click here to see how to use SummarizeAnnotationAnalytics API.

summarizeRecordAnalytics

SummarizeRecordAnalyticsResponse summarizeRecordAnalytics(SummarizeRecordAnalyticsRequest request)

Summarize the records created for a given dataset.

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_Retries

Example: Click here to see how to use SummarizeRecordAnalytics API.

updateAnnotation

UpdateAnnotationResponse updateAnnotation(UpdateAnnotationRequest request)

Updates an annotation.

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_Retries

Example: Click here to see how to use UpdateAnnotation API.

updateRecord

UpdateRecordResponse updateRecord(UpdateRecordRequest request)

Updates a record.

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_Retries

Example: Click here to see how to use UpdateRecord API.

getWaiters

DataLabelingWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

DataLabelingPaginators 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.