Package com.oracle.bmc.datalabelingservicedataplane

Interface DataLabelingAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DataLabelingAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20211001")
public interface DataLabelingAsync
extends AutoCloseable
    Use Data Labeling API to create Annotations on Images, Texts & Documents, and generate snapshots.

    • 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

      • createAnnotation

        Future<CreateAnnotationResponse> createAnnotation​(CreateAnnotationRequest request,
                                                  AsyncHandler<CreateAnnotationRequest,​CreateAnnotationResponse> handler)
        Creates an annotation.
        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.

      • createRecord

        Future<CreateRecordResponse> createRecord​(CreateRecordRequest request,
                                          AsyncHandler<CreateRecordRequest,​CreateRecordResponse> handler)
        Creates a record.
        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.

      • deleteAnnotation

        Future<DeleteAnnotationResponse> deleteAnnotation​(DeleteAnnotationRequest request,
                                                  AsyncHandler<DeleteAnnotationRequest,​DeleteAnnotationResponse> handler)
        It deletes an annotation 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.

      • deleteRecord

        Future<DeleteRecordResponse> deleteRecord​(DeleteRecordRequest request,
                                          AsyncHandler<DeleteRecordRequest,​DeleteRecordResponse> handler)
        Deletes a record 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.

      • getAnnotation

        Future<GetAnnotationResponse> getAnnotation​(GetAnnotationRequest request,
                                            AsyncHandler<GetAnnotationRequest,​GetAnnotationResponse> handler)
        Gets an annotation.
        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.

      • getRecord

        Future<GetRecordResponse> getRecord​(GetRecordRequest request,
                                    AsyncHandler<GetRecordRequest,​GetRecordResponse> handler)
        Gets a record.
        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.

      • getRecordContent

        Future<GetRecordContentResponse> getRecordContent​(GetRecordContentRequest request,
                                                  AsyncHandler<GetRecordContentRequest,​GetRecordContentResponse> handler)
        Retrieves the content of the record from the dataset 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.

      • getRecordPreviewContent

        Future<GetRecordPreviewContentResponse> getRecordPreviewContent​(GetRecordPreviewContentRequest request,
                                                                AsyncHandler<GetRecordPreviewContentRequest,​GetRecordPreviewContentResponse> handler)
        Retrieves the preview of the record content from the dataset 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.

      • listAnnotations

        Future<ListAnnotationsResponse> listAnnotations​(ListAnnotationsRequest request,
                                                AsyncHandler<ListAnnotationsRequest,​ListAnnotationsResponse> handler)
        Returns a list of annotations.
        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.

      • listRecords

        Future<ListRecordsResponse> listRecords​(ListRecordsRequest request,
                                        AsyncHandler<ListRecordsRequest,​ListRecordsResponse> handler)
        The list of records in the specified 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.

      • updateAnnotation

        Future<UpdateAnnotationResponse> updateAnnotation​(UpdateAnnotationRequest request,
                                                  AsyncHandler<UpdateAnnotationRequest,​UpdateAnnotationResponse> handler)
        Updates an annotation.
        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.

      • updateRecord

        Future<UpdateRecordResponse> updateRecord​(UpdateRecordRequest request,
                                          AsyncHandler<UpdateRecordRequest,​UpdateRecordResponse> handler)
        Updates a record.
        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.