Package com.confidentify.client.api

Class DatasetsApi

  • public class DatasetsApi
extends Object

    • Constructor Detail

      • DatasetsApi

        public DatasetsApi()

      • DatasetsApi

        public DatasetsApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • datasetByIdDeleteCall

        public okhttp3.Call datasetByIdDeleteCall​(String datasetId,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for datasetByIdDelete
        Parameters:
        datasetId - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • datasetByIdDelete

        public void datasetByIdDelete​(String datasetId)
                       throws ApiException
        Delete dataset
        Parameters:
        datasetId - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetByIdDeleteWithHttpInfo

        public ApiResponse<Void> datasetByIdDeleteWithHttpInfo​(String datasetId)
                                                throws ApiException
        Delete dataset
        Parameters:
        datasetId - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetByIdDeleteAsync

        public okhttp3.Call datasetByIdDeleteAsync​(String datasetId,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        Delete dataset (asynchronously)
        Parameters:
        datasetId - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • datasetByIdGetCall

        public okhttp3.Call datasetByIdGetCall​(String datasetId,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for datasetByIdGet
        Parameters:
        datasetId - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • datasetByIdGet

        public DatasetAll datasetByIdGet​(String datasetId)
                          throws ApiException
        Get dataset information
        Parameters:
        datasetId - (required)
        Returns:
        DatasetAll
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetByIdGetWithHttpInfo

        public ApiResponse<DatasetAll> datasetByIdGetWithHttpInfo​(String datasetId)
                                                   throws ApiException
        Get dataset information
        Parameters:
        datasetId - (required)
        Returns:
        ApiResponse<DatasetAll>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetByIdGetAsync

        public okhttp3.Call datasetByIdGetAsync​(String datasetId,
                                        ApiCallback<DatasetAll> _callback)
                                 throws ApiException
        Get dataset information (asynchronously)
        Parameters:
        datasetId - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • datasetByIdPostCall

        public okhttp3.Call datasetByIdPostCall​(String datasetId,
                                        DatasetUpdateRequest datasetUpdateRequest,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for datasetByIdPost
        Parameters:
        datasetId - (required)
        datasetUpdateRequest - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • datasetByIdPost

        public DatasetAll datasetByIdPost​(String datasetId,
                                  DatasetUpdateRequest datasetUpdateRequest)
                           throws ApiException
        Update dataset
        Parameters:
        datasetId - (required)
        datasetUpdateRequest - (optional)
        Returns:
        DatasetAll
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetByIdPostWithHttpInfo

        public ApiResponse<DatasetAll> datasetByIdPostWithHttpInfo​(String datasetId,
                                                           DatasetUpdateRequest datasetUpdateRequest)
                                                    throws ApiException
        Update dataset
        Parameters:
        datasetId - (required)
        datasetUpdateRequest - (optional)
        Returns:
        ApiResponse<DatasetAll>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetByIdPostAsync

        public okhttp3.Call datasetByIdPostAsync​(String datasetId,
                                         DatasetUpdateRequest datasetUpdateRequest,
                                         ApiCallback<DatasetAll> _callback)
                                  throws ApiException
        Update dataset (asynchronously)
        Parameters:
        datasetId - (required)
        datasetUpdateRequest - (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • datasetRecordByIdDeleteCall

        public okhttp3.Call datasetRecordByIdDeleteCall​(String datasetId,
                                                String recordId,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for datasetRecordByIdDelete
        Parameters:
        datasetId - (required)
        recordId - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • datasetRecordByIdDelete

        public void datasetRecordByIdDelete​(String datasetId,
                                    String recordId)
                             throws ApiException
        Delete dataset record
        Parameters:
        datasetId - (required)
        recordId - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetRecordByIdDeleteWithHttpInfo

        public ApiResponse<Void> datasetRecordByIdDeleteWithHttpInfo​(String datasetId,
                                                             String recordId)
                                                      throws ApiException
        Delete dataset record
        Parameters:
        datasetId - (required)
        recordId - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetRecordByIdDeleteAsync

        public okhttp3.Call datasetRecordByIdDeleteAsync​(String datasetId,
                                                 String recordId,
                                                 ApiCallback<Void> _callback)
                                          throws ApiException
        Delete dataset record (asynchronously)
        Parameters:
        datasetId - (required)
        recordId - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • datasetRecordByIdGetCall

        public okhttp3.Call datasetRecordByIdGetCall​(String datasetId,
                                             String recordId,
                                             ApiCallback _callback)
                                      throws ApiException
        Build call for datasetRecordByIdGet
        Parameters:
        datasetId - (required)
        recordId - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • datasetRecordByIdGet

        public DatasetRecordAll datasetRecordByIdGet​(String datasetId,
                                             String recordId)
                                      throws ApiException
        Get dataset record information
        Parameters:
        datasetId - (required)
        recordId - (required)
        Returns:
        DatasetRecordAll
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetRecordByIdGetWithHttpInfo

        public ApiResponse<DatasetRecordAll> datasetRecordByIdGetWithHttpInfo​(String datasetId,
                                                                      String recordId)
                                                               throws ApiException
        Get dataset record information
        Parameters:
        datasetId - (required)
        recordId - (required)
        Returns:
        ApiResponse<DatasetRecordAll>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetRecordByIdGetAsync

        public okhttp3.Call datasetRecordByIdGetAsync​(String datasetId,
                                              String recordId,
                                              ApiCallback<DatasetRecordAll> _callback)
                                       throws ApiException
        Get dataset record information (asynchronously)
        Parameters:
        datasetId - (required)
        recordId - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • datasetsGetCall

        public okhttp3.Call datasetsGetCall​(ApiCallback _callback)
                             throws ApiException
        Build call for datasetsGet
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • datasetsGet

        public DatasetListResponse datasetsGet()
                                throws ApiException
        Get available datasets
        Returns:
        DatasetListResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetsGetWithHttpInfo

        public ApiResponse<DatasetListResponse> datasetsGetWithHttpInfo()
                                                         throws ApiException
        Get available datasets
        Returns:
        ApiResponse<DatasetListResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • datasetsGetAsync

        public okhttp3.Call datasetsGetAsync​(ApiCallback<DatasetListResponse> _callback)
                              throws ApiException
        Get available datasets (asynchronously)
        Parameters:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • datasetsPostCall

        public okhttp3.Call datasetsPostCall​(DatasetCreateRequest datasetCreateRequest,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for datasetsPost
        Parameters:
        datasetCreateRequest - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • datasetsPostAsync

        public okhttp3.Call datasetsPostAsync​(DatasetCreateRequest datasetCreateRequest,
                                      ApiCallback<DatasetCreateResponse> _callback)
                               throws ApiException
        Create dataset (asynchronously)
        Parameters:
        datasetCreateRequest - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • ingestDocumentsPostCall

        public okhttp3.Call ingestDocumentsPostCall​(String datasetId,
                                            IngestDocumentsRequest ingestDocumentsRequest,
                                            ApiCallback _callback)
                                     throws ApiException
        Build call for ingestDocumentsPost
        Parameters:
        datasetId - (required)
        ingestDocumentsRequest - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • ingestDocumentsPost

        public void ingestDocumentsPost​(String datasetId,
                                IngestDocumentsRequest ingestDocumentsRequest)
                         throws ApiException
        Initiate ingestion of data from a list of documents. Using this endpoint you can initiate data ingestion based on text documents. Each document will be processed using the `identify` service and the resolved/identified entities will then be added to the dataset as records.
        Parameters:
        datasetId - (required)
        ingestDocumentsRequest - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • ingestDocumentsPostWithHttpInfo

        public ApiResponse<Void> ingestDocumentsPostWithHttpInfo​(String datasetId,
                                                         IngestDocumentsRequest ingestDocumentsRequest)
                                                  throws ApiException
        Initiate ingestion of data from a list of documents. Using this endpoint you can initiate data ingestion based on text documents. Each document will be processed using the `identify` service and the resolved/identified entities will then be added to the dataset as records.
        Parameters:
        datasetId - (required)
        ingestDocumentsRequest - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • ingestDocumentsPostAsync

        public okhttp3.Call ingestDocumentsPostAsync​(String datasetId,
                                             IngestDocumentsRequest ingestDocumentsRequest,
                                             ApiCallback<Void> _callback)
                                      throws ApiException
        Initiate ingestion of data from a list of documents. (asynchronously) Using this endpoint you can initiate data ingestion based on text documents. Each document will be processed using the `identify` service and the resolved/identified entities will then be added to the dataset as records.
        Parameters:
        datasetId - (required)
        ingestDocumentsRequest - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • ingestFilePostCall

        public okhttp3.Call ingestFilePostCall​(String datasetId,
                                       IngestFileRequest ingestFileRequest,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for ingestFilePost
        Parameters:
        datasetId - (required)
        ingestFileRequest - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • ingestFilePost

        public IngestFileResponse ingestFilePost​(String datasetId,
                                         IngestFileRequest ingestFileRequest)
                                  throws ApiException
        Initiate ingestion of data from file upload. Using this endpoint you can initiate data ingestion based on file upload. This endpoint does not accept the actual file for processing, but will validate the request and provide a presigned URL with which the client can continue. The uploaded file will be handled according to the `file_type` provided in the request. In the response of this request, a upload file URL will be provided. The client is expected to `PUT` the file contents towards this URL. Once the file has been uploaded, it will be handled asynchronously.
        Parameters:
        datasetId - (required)
        ingestFileRequest - (required)
        Returns:
        IngestFileResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • ingestFilePostWithHttpInfo

        public ApiResponse<IngestFileResponse> ingestFilePostWithHttpInfo​(String datasetId,
                                                                  IngestFileRequest ingestFileRequest)
                                                           throws ApiException
        Initiate ingestion of data from file upload. Using this endpoint you can initiate data ingestion based on file upload. This endpoint does not accept the actual file for processing, but will validate the request and provide a presigned URL with which the client can continue. The uploaded file will be handled according to the `file_type` provided in the request. In the response of this request, a upload file URL will be provided. The client is expected to `PUT` the file contents towards this URL. Once the file has been uploaded, it will be handled asynchronously.
        Parameters:
        datasetId - (required)
        ingestFileRequest - (required)
        Returns:
        ApiResponse<IngestFileResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • ingestFilePostAsync

        public okhttp3.Call ingestFilePostAsync​(String datasetId,
                                        IngestFileRequest ingestFileRequest,
                                        ApiCallback<IngestFileResponse> _callback)
                                 throws ApiException
        Initiate ingestion of data from file upload. (asynchronously) Using this endpoint you can initiate data ingestion based on file upload. This endpoint does not accept the actual file for processing, but will validate the request and provide a presigned URL with which the client can continue. The uploaded file will be handled according to the `file_type` provided in the request. In the response of this request, a upload file URL will be provided. The client is expected to `PUT` the file contents towards this URL. Once the file has been uploaded, it will be handled asynchronously.
        Parameters:
        datasetId - (required)
        ingestFileRequest - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • recordsGetCall

        public okhttp3.Call recordsGetCall​(String datasetId,
                                   Integer pageSize,
                                   String pageAfter,
                                   String filterIds,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for recordsGet
        Parameters:
        datasetId - (required)
        pageSize - The page size for the response data (optional, default to 100)
        pageAfter - A cursor ID to provide for getting the next page of data. (optional)
        filterIds - A comma-separated list (max 50 items) of IDs to fetch. Using this parameter will disable result paging, so `page[after]` and `page[size]` will have no effect. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • recordsGet

        public RecordsQueryResponse recordsGet​(String datasetId,
                                       Integer pageSize,
                                       String pageAfter,
                                       String filterIds)
                                throws ApiException
        Query records
        Parameters:
        datasetId - (required)
        pageSize - The page size for the response data (optional, default to 100)
        pageAfter - A cursor ID to provide for getting the next page of data. (optional)
        filterIds - A comma-separated list (max 50 items) of IDs to fetch. Using this parameter will disable result paging, so `page[after]` and `page[size]` will have no effect. (optional)
        Returns:
        RecordsQueryResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recordsGetWithHttpInfo

        public ApiResponse<RecordsQueryResponse> recordsGetWithHttpInfo​(String datasetId,
                                                                Integer pageSize,
                                                                String pageAfter,
                                                                String filterIds)
                                                         throws ApiException
        Query records
        Parameters:
        datasetId - (required)
        pageSize - The page size for the response data (optional, default to 100)
        pageAfter - A cursor ID to provide for getting the next page of data. (optional)
        filterIds - A comma-separated list (max 50 items) of IDs to fetch. Using this parameter will disable result paging, so `page[after]` and `page[size]` will have no effect. (optional)
        Returns:
        ApiResponse<RecordsQueryResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recordsGetAsync

        public okhttp3.Call recordsGetAsync​(String datasetId,
                                    Integer pageSize,
                                    String pageAfter,
                                    String filterIds,
                                    ApiCallback<RecordsQueryResponse> _callback)
                             throws ApiException
        Query records (asynchronously)
        Parameters:
        datasetId - (required)
        pageSize - The page size for the response data (optional, default to 100)
        pageAfter - A cursor ID to provide for getting the next page of data. (optional)
        filterIds - A comma-separated list (max 50 items) of IDs to fetch. Using this parameter will disable result paging, so `page[after]` and `page[size]` will have no effect. (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • recordsPostCall

        public okhttp3.Call recordsPostCall​(String datasetId,
                                    RecordsUploadRequest recordsUploadRequest,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for recordsPost
        Parameters:
        datasetId - (required)
        recordsUploadRequest - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • recordsPost

        public void recordsPost​(String datasetId,
                        RecordsUploadRequest recordsUploadRequest)
                 throws ApiException
        Upload records
        Parameters:
        datasetId - (required)
        recordsUploadRequest - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recordsPostWithHttpInfo

        public ApiResponse<Void> recordsPostWithHttpInfo​(String datasetId,
                                                 RecordsUploadRequest recordsUploadRequest)
                                          throws ApiException
        Upload records
        Parameters:
        datasetId - (required)
        recordsUploadRequest - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • recordsPostAsync

        public okhttp3.Call recordsPostAsync​(String datasetId,
                                     RecordsUploadRequest recordsUploadRequest,
                                     ApiCallback<Void> _callback)
                              throws ApiException
        Upload records (asynchronously)
        Parameters:
        datasetId - (required)
        recordsUploadRequest - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object