com.oracle.bmc.datalabelingservicedataplane

Class DataLabelingClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.datalabelingservicedataplane.DataLabelingClient

All Implemented Interfaces:

DataLabeling, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public class DataLabelingClient
extends BaseSyncClient
implements DataLabeling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataLabelingClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 DataLabeling.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DataLabelingClient.Builder	builder() Create a builder for this client.
void	close()
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.
String	getClientCommonLibraryVersion()
GetDatasetResponse	getDataset(GetDatasetRequest request) Gets a dataset by identifier.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	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’).
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.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateRecordResponse	updateRecord(UpdateRecordRequest request) Updates a record.
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.datalabelingservicedataplane.DataLabeling

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DataLabeling.

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

DataLabelingClient

@Deprecated
public DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

DataLabelingClient

@Deprecated
public DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DataLabelingClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DataLabelingClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DataLabelingClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DataLabelingClient

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

DataLabelingClient

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

DataLabelingClient

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

Method Detail

builder

public static DataLabelingClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DataLabeling

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 DataLabeling

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DataLabeling

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 DataLabeling

Parameters:

regionId - The public region ID.

createAnnotation

public CreateAnnotationResponse createAnnotation(CreateAnnotationRequest request)

Description copied from interface: DataLabeling

Creates an annotation.

Specified by:

createAnnotation in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRecord

public CreateRecordResponse createRecord(CreateRecordRequest request)

Description copied from interface: DataLabeling

Creates a record.

Specified by:

createRecord in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAnnotation

public DeleteAnnotationResponse deleteAnnotation(DeleteAnnotationRequest request)

Description copied from interface: DataLabeling

It deletes an annotation resource by identifier.

Specified by:

deleteAnnotation in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRecord

public DeleteRecordResponse deleteRecord(DeleteRecordRequest request)

Description copied from interface: DataLabeling

Deletes a record resource by identifier.

Specified by:

deleteRecord in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAnnotation

public GetAnnotationResponse getAnnotation(GetAnnotationRequest request)

Description copied from interface: DataLabeling

Gets an annotation.

Specified by:

getAnnotation in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDataset

public GetDatasetResponse getDataset(GetDatasetRequest request)

Description copied from interface: DataLabeling

Gets a dataset by identifier.

Specified by:

getDataset in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRecord

public GetRecordResponse getRecord(GetRecordRequest request)

Description copied from interface: DataLabeling

Gets a record.

Specified by:

getRecord in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRecordContent

public GetRecordContentResponse getRecordContent(GetRecordContentRequest request)

Description copied from interface: DataLabeling

Retrieves the content of the record from the dataset source.

Specified by:

getRecordContent in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRecordPreviewContent

public GetRecordPreviewContentResponse getRecordPreviewContent(GetRecordPreviewContentRequest request)

Description copied from interface: DataLabeling

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

Specified by:

getRecordPreviewContent in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAnnotations

public ListAnnotationsResponse listAnnotations(ListAnnotationsRequest request)

Description copied from interface: DataLabeling

Returns a list of annotations.

Specified by:

listAnnotations in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRecords

public ListRecordsResponse listRecords(ListRecordsRequest request)

Description copied from interface: DataLabeling

The list of records in the specified compartment.

Specified by:

listRecords in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeAnnotationAnalytics

public SummarizeAnnotationAnalyticsResponse summarizeAnnotationAnalytics(SummarizeAnnotationAnalyticsRequest request)

Description copied from interface: DataLabeling

Summarize the annotations created for a given dataset.

Specified by:

summarizeAnnotationAnalytics in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeRecordAnalytics

public SummarizeRecordAnalyticsResponse summarizeRecordAnalytics(SummarizeRecordAnalyticsRequest request)

Description copied from interface: DataLabeling

Summarize the records created for a given dataset.

Specified by:

summarizeRecordAnalytics in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAnnotation

public UpdateAnnotationResponse updateAnnotation(UpdateAnnotationRequest request)

Description copied from interface: DataLabeling

Updates an annotation.

Specified by:

updateAnnotation in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRecord

public UpdateRecordResponse updateRecord(UpdateRecordRequest request)

Description copied from interface: DataLabeling

Updates a record.

Specified by:

updateRecord in interface DataLabeling

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DataLabelingWaiters getWaiters()

Description copied from interface: DataLabeling

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

Specified by:

getWaiters in interface DataLabeling

Returns:

The service waiters.

getPaginators

public DataLabelingPaginators getPaginators()

Description copied from interface: DataLabeling

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 DataLabeling

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