DataLabelingClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.datalabelingservicedataplane.DataLabelingClient

All Implemented Interfaces:: DataLabeling, AutoCloseable

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataLabelingClient.Builder
Builder class for this client.

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

static Service SERVICE
Service instance for DataLabeling.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for DataLabeling.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)` Creates a new service instance using the given authentication provider and client configuration.
	`DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)` Creates a new service instance using the given authentication provider and client configuration.
`protected`	`DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)` Creates a new service instance using the given authentication provider and client configuration.
	`DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`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`	`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for DataLabeling.
- Constructor Detail
  - DataLabelingClient
```
public DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - DataLabelingClient
```
public DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - DataLabelingClient
```
public DataLabelingClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
  - DataLabelingClient
```
public DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
  - DataLabelingClient
```
public DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          List<ClientConfigurator> additionalClientConfigurators)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - DataLabelingClient
```
public DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - DataLabelingClient
```
public DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - DataLabelingClient
```
public DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          ExecutorService executorService)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
  - DataLabelingClient
```
protected DataLabelingClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             ExecutorService executorService,
                             RestClientFactoryBuilder restClientFactoryBuilder)
```
    Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
    
    This is an advanced constructor for clients that want to take control over how requests are signed. Use the DataLabelingClient.Builder to get access to all these parameters.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
    
    clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.
    
    defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.
    
    signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
    
    executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static DataLabelingClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: DataLabeling
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface DataLabeling
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: DataLabeling
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface DataLabeling
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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.

Class DataLabelingClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

DataLabelingClient

DataLabelingClient

DataLabelingClient

DataLabelingClient

DataLabelingClient

DataLabelingClient

DataLabelingClient

DataLabelingClient

DataLabelingClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

createAnnotation

createRecord

deleteAnnotation

deleteRecord

getAnnotation

getDataset

getRecord

getRecordContent

getRecordPreviewContent

listAnnotations

listRecords

summarizeAnnotationAnalytics

summarizeRecordAnalytics

updateAnnotation

updateRecord

getWaiters

getPaginators