Package io.tiledb.cloud.rest_api.api

Class TasksApi

  • public class TasksApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ApiClient getApiClient()  
      java.lang.String getCustomBaseUrl()  
      int getHostIndex()  
      java.util.List<java.lang.Object> runSQL​(java.lang.String namespace, SQLParameters sql, java.lang.String acceptEncoding)
      Run a sql query
      okhttp3.Call runSQLAsync​(java.lang.String namespace, SQLParameters sql, java.lang.String acceptEncoding, ApiCallback<java.util.List<java.lang.Object>> _callback)
      (asynchronously) Run a sql query
      okhttp3.Call runSQLCall​(java.lang.String namespace, SQLParameters sql, java.lang.String acceptEncoding, ApiCallback _callback)
      Build call for runSQL
      ApiResponse<java.util.List<java.lang.Object>> runSQLWithHttpInfo​(java.lang.String namespace, SQLParameters sql, java.lang.String acceptEncoding)
      Run a sql query
      void setApiClient​(ApiClient apiClient)  
      void setCustomBaseUrl​(java.lang.String customBaseUrl)  
      void setHostIndex​(int hostIndex)  
      ArrayTask taskIdGet​(java.lang.String id)
      Fetch an array task
      okhttp3.Call taskIdGetAsync​(java.lang.String id, ApiCallback<ArrayTask> _callback)
      (asynchronously) Fetch an array task
      okhttp3.Call taskIdGetCall​(java.lang.String id, ApiCallback _callback)
      Build call for taskIdGet
      ApiResponse<ArrayTask> taskIdGetWithHttpInfo​(java.lang.String id)
      Fetch an array task
      java.lang.String taskIdResultGet​(java.lang.String id, java.lang.String acceptEncoding)
      Retrieve results of an array task
      okhttp3.Call taskIdResultGetAsync​(java.lang.String id, java.lang.String acceptEncoding, ApiCallback<java.lang.String> _callback)
      (asynchronously) Retrieve results of an array task
      okhttp3.Call taskIdResultGetCall​(java.lang.String id, java.lang.String acceptEncoding, ApiCallback _callback)
      Build call for taskIdResultGet
      ApiResponse<java.lang.String> taskIdResultGetWithHttpInfo​(java.lang.String id, java.lang.String acceptEncoding)
      Retrieve results of an array task
      ArrayTaskData tasksGet​(java.lang.String namespace, java.lang.String createdBy, java.lang.String array, java.lang.Integer start, java.lang.Integer end, java.lang.Integer page, java.lang.Integer perPage, java.lang.String type, java.util.List<java.lang.String> excludeType, java.util.List<java.lang.String> fileType, java.util.List<java.lang.String> excludeFileType, java.lang.String status, java.lang.String search, java.lang.String orderby)
      Fetch a list of all array tasks a user has access to
      okhttp3.Call tasksGetAsync​(java.lang.String namespace, java.lang.String createdBy, java.lang.String array, java.lang.Integer start, java.lang.Integer end, java.lang.Integer page, java.lang.Integer perPage, java.lang.String type, java.util.List<java.lang.String> excludeType, java.util.List<java.lang.String> fileType, java.util.List<java.lang.String> excludeFileType, java.lang.String status, java.lang.String search, java.lang.String orderby, ApiCallback<ArrayTaskData> _callback)
      (asynchronously) Fetch a list of all array tasks a user has access to
      okhttp3.Call tasksGetCall​(java.lang.String namespace, java.lang.String createdBy, java.lang.String array, java.lang.Integer start, java.lang.Integer end, java.lang.Integer page, java.lang.Integer perPage, java.lang.String type, java.util.List<java.lang.String> excludeType, java.util.List<java.lang.String> fileType, java.util.List<java.lang.String> excludeFileType, java.lang.String status, java.lang.String search, java.lang.String orderby, ApiCallback _callback)
      Build call for tasksGet
      ApiResponse<ArrayTaskData> tasksGetWithHttpInfo​(java.lang.String namespace, java.lang.String createdBy, java.lang.String array, java.lang.Integer start, java.lang.Integer end, java.lang.Integer page, java.lang.Integer perPage, java.lang.String type, java.util.List<java.lang.String> excludeType, java.util.List<java.lang.String> fileType, java.util.List<java.lang.String> excludeFileType, java.lang.String status, java.lang.String search, java.lang.String orderby)
      Fetch a list of all array tasks a user has access to

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TasksApi

        public TasksApi()

      • TasksApi

        public TasksApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • runSQLCall

        public okhttp3.Call runSQLCall​(java.lang.String namespace,
                               SQLParameters sql,
                               java.lang.String acceptEncoding,
                               ApiCallback _callback)
                        throws ApiException
        Build call for runSQL
        Parameters:
        namespace - namespace to run task under is in (an organization name or user's username) (required)
        sql - sql being submitted (required)
        acceptEncoding - Encoding to use (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • runSQL

        public java.util.List<java.lang.Object> runSQL​(java.lang.String namespace,
                                               SQLParameters sql,
                                               java.lang.String acceptEncoding)
                                        throws ApiException
        Run a sql query
        Parameters:
        namespace - namespace to run task under is in (an organization name or user's username) (required)
        sql - sql being submitted (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        List<Object>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • runSQLWithHttpInfo

        public ApiResponse<java.util.List<java.lang.Object>> runSQLWithHttpInfo​(java.lang.String namespace,
                                                                        SQLParameters sql,
                                                                        java.lang.String acceptEncoding)
                                                                 throws ApiException
        Run a sql query
        Parameters:
        namespace - namespace to run task under is in (an organization name or user's username) (required)
        sql - sql being submitted (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<List<Object>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • runSQLAsync

        public okhttp3.Call runSQLAsync​(java.lang.String namespace,
                                SQLParameters sql,
                                java.lang.String acceptEncoding,
                                ApiCallback<java.util.List<java.lang.Object>> _callback)
                         throws ApiException
        (asynchronously) Run a sql query
        Parameters:
        namespace - namespace to run task under is in (an organization name or user's username) (required)
        sql - sql being submitted (required)
        acceptEncoding - Encoding to use (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

      • taskIdGetCall

        public okhttp3.Call taskIdGetCall​(java.lang.String id,
                                  ApiCallback _callback)
                           throws ApiException
        Build call for taskIdGet
        Parameters:
        id - task ID to fetch (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • taskIdGet

        public ArrayTask taskIdGet​(java.lang.String id)
                    throws ApiException
        Fetch an array task
        Parameters:
        id - task ID to fetch (required)
        Returns:
        ArrayTask
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • taskIdGetWithHttpInfo

        public ApiResponse<ArrayTask> taskIdGetWithHttpInfo​(java.lang.String id)
                                             throws ApiException
        Fetch an array task
        Parameters:
        id - task ID to fetch (required)
        Returns:
        ApiResponse<ArrayTask>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • taskIdGetAsync

        public okhttp3.Call taskIdGetAsync​(java.lang.String id,
                                   ApiCallback<ArrayTask> _callback)
                            throws ApiException
        (asynchronously) Fetch an array task
        Parameters:
        id - task ID to fetch (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

      • taskIdResultGetCall

        public okhttp3.Call taskIdResultGetCall​(java.lang.String id,
                                        java.lang.String acceptEncoding,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for taskIdResultGet
        Parameters:
        id - task ID to retrieve stored results (required)
        acceptEncoding - Encoding to use (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • taskIdResultGet

        public java.lang.String taskIdResultGet​(java.lang.String id,
                                        java.lang.String acceptEncoding)
                                 throws ApiException
        Retrieve results of an array task
        Parameters:
        id - task ID to retrieve stored results (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        String
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • taskIdResultGetWithHttpInfo

        public ApiResponse<java.lang.String> taskIdResultGetWithHttpInfo​(java.lang.String id,
                                                                 java.lang.String acceptEncoding)
                                                          throws ApiException
        Retrieve results of an array task
        Parameters:
        id - task ID to retrieve stored results (required)
        acceptEncoding - Encoding to use (optional)
        Returns:
        ApiResponse<String>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • taskIdResultGetAsync

        public okhttp3.Call taskIdResultGetAsync​(java.lang.String id,
                                         java.lang.String acceptEncoding,
                                         ApiCallback<java.lang.String> _callback)
                                  throws ApiException
        (asynchronously) Retrieve results of an array task
        Parameters:
        id - task ID to retrieve stored results (required)
        acceptEncoding - Encoding to use (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

      • tasksGetCall

        public okhttp3.Call tasksGetCall​(java.lang.String namespace,
                                 java.lang.String createdBy,
                                 java.lang.String array,
                                 java.lang.Integer start,
                                 java.lang.Integer end,
                                 java.lang.Integer page,
                                 java.lang.Integer perPage,
                                 java.lang.String type,
                                 java.util.List<java.lang.String> excludeType,
                                 java.util.List<java.lang.String> fileType,
                                 java.util.List<java.lang.String> excludeFileType,
                                 java.lang.String status,
                                 java.lang.String search,
                                 java.lang.String orderby,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for tasksGet
        Parameters:
        namespace - namespace to filter (optional)
        createdBy - username to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" (optional)
        excludeType - task_type to exclude matching array in results, more than one can be included (optional)
        fileType - match file_type of task array, more than one can be included (optional)
        excludeFileType - exclude file_type of task arrays, more than one can be included (optional)
        status - Filter to only return these statuses (optional)
        search - search string that will look at name, namespace or description fields (optional)
        orderby - sort by which field valid values include start_time, name (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • tasksGet

        public ArrayTaskData tasksGet​(java.lang.String namespace,
                              java.lang.String createdBy,
                              java.lang.String array,
                              java.lang.Integer start,
                              java.lang.Integer end,
                              java.lang.Integer page,
                              java.lang.Integer perPage,
                              java.lang.String type,
                              java.util.List<java.lang.String> excludeType,
                              java.util.List<java.lang.String> fileType,
                              java.util.List<java.lang.String> excludeFileType,
                              java.lang.String status,
                              java.lang.String search,
                              java.lang.String orderby)
                       throws ApiException
        Fetch a list of all array tasks a user has access to
        Parameters:
        namespace - namespace to filter (optional)
        createdBy - username to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" (optional)
        excludeType - task_type to exclude matching array in results, more than one can be included (optional)
        fileType - match file_type of task array, more than one can be included (optional)
        excludeFileType - exclude file_type of task arrays, more than one can be included (optional)
        status - Filter to only return these statuses (optional)
        search - search string that will look at name, namespace or description fields (optional)
        orderby - sort by which field valid values include start_time, name (optional)
        Returns:
        ArrayTaskData
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • tasksGetWithHttpInfo

        public ApiResponse<ArrayTaskData> tasksGetWithHttpInfo​(java.lang.String namespace,
                                                       java.lang.String createdBy,
                                                       java.lang.String array,
                                                       java.lang.Integer start,
                                                       java.lang.Integer end,
                                                       java.lang.Integer page,
                                                       java.lang.Integer perPage,
                                                       java.lang.String type,
                                                       java.util.List<java.lang.String> excludeType,
                                                       java.util.List<java.lang.String> fileType,
                                                       java.util.List<java.lang.String> excludeFileType,
                                                       java.lang.String status,
                                                       java.lang.String search,
                                                       java.lang.String orderby)
                                                throws ApiException
        Fetch a list of all array tasks a user has access to
        Parameters:
        namespace - namespace to filter (optional)
        createdBy - username to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" (optional)
        excludeType - task_type to exclude matching array in results, more than one can be included (optional)
        fileType - match file_type of task array, more than one can be included (optional)
        excludeFileType - exclude file_type of task arrays, more than one can be included (optional)
        status - Filter to only return these statuses (optional)
        search - search string that will look at name, namespace or description fields (optional)
        orderby - sort by which field valid values include start_time, name (optional)
        Returns:
        ApiResponse<ArrayTaskData>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • tasksGetAsync

        public okhttp3.Call tasksGetAsync​(java.lang.String namespace,
                                  java.lang.String createdBy,
                                  java.lang.String array,
                                  java.lang.Integer start,
                                  java.lang.Integer end,
                                  java.lang.Integer page,
                                  java.lang.Integer perPage,
                                  java.lang.String type,
                                  java.util.List<java.lang.String> excludeType,
                                  java.util.List<java.lang.String> fileType,
                                  java.util.List<java.lang.String> excludeFileType,
                                  java.lang.String status,
                                  java.lang.String search,
                                  java.lang.String orderby,
                                  ApiCallback<ArrayTaskData> _callback)
                           throws ApiException
        (asynchronously) Fetch a list of all array tasks a user has access to
        Parameters:
        namespace - namespace to filter (optional)
        createdBy - username to filter (optional)
        array - name/uri of array that is url-encoded to filter (optional)
        start - start time for tasks to filter by (optional)
        end - end time for tasks to filter by (optional)
        page - pagination offset (optional)
        perPage - pagination limit (optional)
        type - task type, \"QUERY\", \"SQL\", \"UDF\", \"GENERIC_UDF\" (optional)
        excludeType - task_type to exclude matching array in results, more than one can be included (optional)
        fileType - match file_type of task array, more than one can be included (optional)
        excludeFileType - exclude file_type of task arrays, more than one can be included (optional)
        status - Filter to only return these statuses (optional)
        search - search string that will look at name, namespace or description fields (optional)
        orderby - sort by which field valid values include start_time, name (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