Class DataLabelingManagementClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.datalabelingservice.DataLabelingManagementClient
-
- All Implemented Interfaces:
DataLabelingManagement
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20211001") public class DataLabelingManagementClient extends BaseSyncClient implements DataLabelingManagement
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataLabelingManagementClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for DataLabelingManagement.
-
Constructor Summary
Constructors Constructor Description DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddDatasetLabelsResponse
addDatasetLabels(AddDatasetLabelsRequest request)
Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.static DataLabelingManagementClient.Builder
builder()
Create a builder for this client.ChangeDatasetCompartmentResponse
changeDatasetCompartment(ChangeDatasetCompartmentRequest request)
Moves a Dataset resource from one compartment identifier to another.void
close()
CreateDatasetResponse
createDataset(CreateDatasetRequest request)
Creates a new Dataset.DeleteDatasetResponse
deleteDataset(DeleteDatasetRequest request)
Deletes a Dataset resource by identifierGenerateDatasetRecordsResponse
generateDatasetRecords(GenerateDatasetRecordsRequest request)
Generates Record resources from the Dataset’s data sourceString
getClientCommonLibraryVersion()
GetDatasetResponse
getDataset(GetDatasetRequest request)
Gets a Dataset by identifierprotected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
DataLabelingManagementPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.DataLabelingManagementWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponse
getWorkRequest(GetWorkRequestRequest request)
Gets the status of the work request with the given ID.ImportPreAnnotatedDataResponse
importPreAnnotatedData(ImportPreAnnotatedDataRequest request)
Imports records and annotations from dataset files into existing Dataset.ListAnnotationFormatsResponse
listAnnotationFormats(ListAnnotationFormatsRequest request)
These are a static list in a given region.ListDatasetsResponse
listDatasets(ListDatasetsRequest request)
Returns a list of Datasets.ListWorkRequestErrorsResponse
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Return a (paginated) list of errors for a given work request.ListWorkRequestLogsResponse
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Return a (paginated) list of logs for a given work request.ListWorkRequestsResponse
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.void
populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.void
refreshClient()
Rebuild the backingHttpClient
.RemoveDatasetLabelsResponse
removeDatasetLabels(RemoveDatasetLabelsRequest request)
Removes the labels from the Dataset Labelset.RenameDatasetLabelsResponse
renameDatasetLabels(RenameDatasetLabelsRequest request)
Renames the labels from the Dataset Labelset.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’).SnapshotDatasetResponse
snapshotDataset(SnapshotDatasetRequest request)
Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption.void
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.UpdateDatasetResponse
updateDataset(UpdateDatasetRequest request)
Updates the Datasetvoid
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 java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.datalabelingservice.DataLabelingManagement
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.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)
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.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
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDataLabelingManagementClient.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
-DataLabelingManagementClient.Builder.executorService
-
-
Method Detail
-
builder
public static DataLabelingManagementClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DataLabelingManagement
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 interfaceDataLabelingManagement
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DataLabelingManagement
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
.- Specified by:
setRegion
in interfaceDataLabelingManagement
- Parameters:
regionId
- The public region ID.
-
addDatasetLabels
public AddDatasetLabelsResponse addDatasetLabels(AddDatasetLabelsRequest request)
Description copied from interface:DataLabelingManagement
Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.- Specified by:
addDatasetLabels
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeDatasetCompartment
public ChangeDatasetCompartmentResponse changeDatasetCompartment(ChangeDatasetCompartmentRequest request)
Description copied from interface:DataLabelingManagement
Moves a Dataset resource from one compartment identifier to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeDatasetCompartment
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createDataset
public CreateDatasetResponse createDataset(CreateDatasetRequest request)
Description copied from interface:DataLabelingManagement
Creates a new Dataset.- Specified by:
createDataset
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteDataset
public DeleteDatasetResponse deleteDataset(DeleteDatasetRequest request)
Description copied from interface:DataLabelingManagement
Deletes a Dataset resource by identifier- Specified by:
deleteDataset
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateDatasetRecords
public GenerateDatasetRecordsResponse generateDatasetRecords(GenerateDatasetRecordsRequest request)
Description copied from interface:DataLabelingManagement
Generates Record resources from the Dataset’s data source- Specified by:
generateDatasetRecords
in interfaceDataLabelingManagement
- 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:DataLabelingManagement
Gets a Dataset by identifier- Specified by:
getDataset
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWorkRequest
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Description copied from interface:DataLabelingManagement
Gets the status of the work request with the given ID.- Specified by:
getWorkRequest
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importPreAnnotatedData
public ImportPreAnnotatedDataResponse importPreAnnotatedData(ImportPreAnnotatedDataRequest request)
Description copied from interface:DataLabelingManagement
Imports records and annotations from dataset files into existing Dataset.- Specified by:
importPreAnnotatedData
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAnnotationFormats
public ListAnnotationFormatsResponse listAnnotationFormats(ListAnnotationFormatsRequest request)
Description copied from interface:DataLabelingManagement
These are a static list in a given region.- Specified by:
listAnnotationFormats
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listDatasets
public ListDatasetsResponse listDatasets(ListDatasetsRequest request)
Description copied from interface:DataLabelingManagement
Returns a list of Datasets.- Specified by:
listDatasets
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestErrors
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Description copied from interface:DataLabelingManagement
Return a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrors
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequestLogs
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Description copied from interface:DataLabelingManagement
Return a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogs
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listWorkRequests
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Description copied from interface:DataLabelingManagement
Lists the work requests in a compartment.- Specified by:
listWorkRequests
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
removeDatasetLabels
public RemoveDatasetLabelsResponse removeDatasetLabels(RemoveDatasetLabelsRequest request)
Description copied from interface:DataLabelingManagement
Removes the labels from the Dataset Labelset.Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names.
- Specified by:
removeDatasetLabels
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
renameDatasetLabels
public RenameDatasetLabelsResponse renameDatasetLabels(RenameDatasetLabelsRequest request)
Description copied from interface:DataLabelingManagement
Renames the labels from the Dataset Labelset.Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names.
- Specified by:
renameDatasetLabels
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
snapshotDataset
public SnapshotDatasetResponse snapshotDataset(SnapshotDatasetRequest request)
Description copied from interface:DataLabelingManagement
Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption.While the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time.
- Specified by:
snapshotDataset
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateDataset
public UpdateDatasetResponse updateDataset(UpdateDatasetRequest request)
Description copied from interface:DataLabelingManagement
Updates the Dataset- Specified by:
updateDataset
in interfaceDataLabelingManagement
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DataLabelingManagementWaiters getWaiters()
Description copied from interface:DataLabelingManagement
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceDataLabelingManagement
- Returns:
- The service waiters.
-
getPaginators
public DataLabelingManagementPaginators getPaginators()
Description copied from interface:DataLabelingManagement
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 interfaceDataLabelingManagement
- 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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-