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 classDataLabelingManagementClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for DataLabelingManagement.
-
Constructor Summary
Constructors Constructor Description DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.DataLabelingManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AddDatasetLabelsResponseaddDatasetLabels(AddDatasetLabelsRequest request)Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.static DataLabelingManagementClient.Builderbuilder()Create a builder for this client.ChangeDatasetCompartmentResponsechangeDatasetCompartment(ChangeDatasetCompartmentRequest request)Moves a Dataset resource from one compartment identifier to another.voidclose()CreateDatasetResponsecreateDataset(CreateDatasetRequest request)Creates a new Dataset.DeleteDatasetResponsedeleteDataset(DeleteDatasetRequest request)Deletes a Dataset resource by identifierGenerateDatasetRecordsResponsegenerateDatasetRecords(GenerateDatasetRecordsRequest request)Generates Record resources from the Dataset’s data sourceStringgetClientCommonLibraryVersion()GetDatasetResponsegetDataset(GetDatasetRequest request)Gets a Dataset by identifierprotected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Optional<String>getMinimumClientCommonLibraryVersionFromClient()DataLabelingManagementPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.DataLabelingManagementWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the status of the work request with the given ID.ImportPreAnnotatedDataResponseimportPreAnnotatedData(ImportPreAnnotatedDataRequest request)Imports records and annotations from dataset files into existing Dataset.ListAnnotationFormatsResponselistAnnotationFormats(ListAnnotationFormatsRequest request)These are a static list in a given region.ListDatasetsResponselistDatasets(ListDatasetsRequest request)Returns a list of Datasets.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Return a (paginated) list of errors for a given work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Return a (paginated) list of logs for a given work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.RemoveDatasetLabelsResponseremoveDatasetLabels(RemoveDatasetLabelsRequest request)Removes the labels from the Dataset Labelset.RenameDatasetLabelsResponserenameDatasetLabels(RenameDatasetLabelsRequest request)Renames the labels from the Dataset Labelset.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).SnapshotDatasetResponsesnapshotDataset(SnapshotDatasetRequest request)Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption.voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateDatasetResponseupdateDataset(UpdateDatasetRequest request)Updates the DatasetvoiduseRealmSpecificEndpointTemplate(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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
DataLabelingManagementClient
@Deprecated public DataLabelingManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeDataLabelingManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:DataLabelingManagementSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceDataLabelingManagement- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DataLabelingManagementSets 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:
setRegionin interfaceDataLabelingManagement- Parameters:
regionId- The public region ID.
-
addDatasetLabels
public AddDatasetLabelsResponse addDatasetLabels(AddDatasetLabelsRequest request)
Description copied from interface:DataLabelingManagementAdd Labels to the Dataset LabelSet until the maximum number of Labels has been reached.- Specified by:
addDatasetLabelsin 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:DataLabelingManagementMoves a Dataset resource from one compartment identifier to another.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeDatasetCompartmentin 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:DataLabelingManagementCreates a new Dataset.- Specified by:
createDatasetin 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:DataLabelingManagementDeletes a Dataset resource by identifier- Specified by:
deleteDatasetin 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:DataLabelingManagementGenerates Record resources from the Dataset’s data source- Specified by:
generateDatasetRecordsin 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:DataLabelingManagementGets a Dataset by identifier- Specified by:
getDatasetin 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:DataLabelingManagementGets the status of the work request with the given ID.- Specified by:
getWorkRequestin 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:DataLabelingManagementImports records and annotations from dataset files into existing Dataset.- Specified by:
importPreAnnotatedDatain 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:DataLabelingManagementThese are a static list in a given region.- Specified by:
listAnnotationFormatsin 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:DataLabelingManagementReturns a list of Datasets.- Specified by:
listDatasetsin 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:DataLabelingManagementReturn a (paginated) list of errors for a given work request.- Specified by:
listWorkRequestErrorsin 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:DataLabelingManagementReturn a (paginated) list of logs for a given work request.- Specified by:
listWorkRequestLogsin 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:DataLabelingManagementLists the work requests in a compartment.- Specified by:
listWorkRequestsin 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:DataLabelingManagementRemoves 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:
removeDatasetLabelsin 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:DataLabelingManagementRenames 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:
renameDatasetLabelsin 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:DataLabelingManagementWrites 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:
snapshotDatasetin 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:DataLabelingManagementUpdates the Dataset- Specified by:
updateDatasetin 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:DataLabelingManagementGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceDataLabelingManagement- Returns:
- The service waiters.
-
getPaginators
public DataLabelingManagementPaginators getPaginators()
Description copied from interface:DataLabelingManagementGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin 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
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-