Package com.oracle.bmc.datalabelingservice

Interface DataLabelingManagementAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DataLabelingManagementAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public interface DataLabelingManagementAsync
extends AutoCloseable
    Use Data Labeling Management API to create, list, edit & delete datasets.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • addDatasetLabels

        Future<AddDatasetLabelsResponse> addDatasetLabels​(AddDatasetLabelsRequest request,
                                                  AsyncHandler<AddDatasetLabelsRequest,​AddDatasetLabelsResponse> handler)
        Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • changeDatasetCompartment

        Future<ChangeDatasetCompartmentResponse> changeDatasetCompartment​(ChangeDatasetCompartmentRequest request,
                                                                  AsyncHandler<ChangeDatasetCompartmentRequest,​ChangeDatasetCompartmentResponse> handler)
        Moves a Dataset resource from one compartment identifier to another.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createDataset

        Future<CreateDatasetResponse> createDataset​(CreateDatasetRequest request,
                                            AsyncHandler<CreateDatasetRequest,​CreateDatasetResponse> handler)
        Creates a new Dataset.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteDataset

        Future<DeleteDatasetResponse> deleteDataset​(DeleteDatasetRequest request,
                                            AsyncHandler<DeleteDatasetRequest,​DeleteDatasetResponse> handler)
        Deletes a Dataset resource by identifier
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • generateDatasetRecords

        Future<GenerateDatasetRecordsResponse> generateDatasetRecords​(GenerateDatasetRecordsRequest request,
                                                              AsyncHandler<GenerateDatasetRecordsRequest,​GenerateDatasetRecordsResponse> handler)
        Generates Record resources from the Dataset’s data source
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDataset

        Future<GetDatasetResponse> getDataset​(GetDatasetRequest request,
                                      AsyncHandler<GetDatasetRequest,​GetDatasetResponse> handler)
        Gets a Dataset by identifier
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Gets the status of the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • importPreAnnotatedData

        Future<ImportPreAnnotatedDataResponse> importPreAnnotatedData​(ImportPreAnnotatedDataRequest request,
                                                              AsyncHandler<ImportPreAnnotatedDataRequest,​ImportPreAnnotatedDataResponse> handler)
        Imports records and annotations from dataset files into existing Dataset.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listAnnotationFormats

        Future<ListAnnotationFormatsResponse> listAnnotationFormats​(ListAnnotationFormatsRequest request,
                                                            AsyncHandler<ListAnnotationFormatsRequest,​ListAnnotationFormatsResponse> handler)
        These are a static list in a given region.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listDatasets

        Future<ListDatasetsResponse> listDatasets​(ListDatasetsRequest request,
                                          AsyncHandler<ListDatasetsRequest,​ListDatasetsResponse> handler)
        Returns a list of Datasets.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Return a (paginated) list of errors for a given work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Return a (paginated) list of logs for a given work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists the work requests in a compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • removeDatasetLabels

        Future<RemoveDatasetLabelsResponse> removeDatasetLabels​(RemoveDatasetLabelsRequest request,
                                                        AsyncHandler<RemoveDatasetLabelsRequest,​RemoveDatasetLabelsResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • renameDatasetLabels

        Future<RenameDatasetLabelsResponse> renameDatasetLabels​(RenameDatasetLabelsRequest request,
                                                        AsyncHandler<RenameDatasetLabelsRequest,​RenameDatasetLabelsResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • snapshotDataset

        Future<SnapshotDatasetResponse> snapshotDataset​(SnapshotDatasetRequest request,
                                                AsyncHandler<SnapshotDatasetRequest,​SnapshotDatasetResponse> handler)
        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.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateDataset

        Future<UpdateDatasetResponse> updateDataset​(UpdateDatasetRequest request,
                                            AsyncHandler<UpdateDatasetRequest,​UpdateDatasetResponse> handler)
        Updates the Dataset
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.