Package io.tiledb.cloud.rest_api.api

Class QueryApi

  • public class QueryApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Query finalizeQuery​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt)
      send a query to run against a specified array/URI registered to a group/project
      okhttp3.Call finalizeQueryAsync​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt, ApiCallback<Query> _callback)
      (asynchronously) send a query to run against a specified array/URI registered to a group/project
      okhttp3.Call finalizeQueryCall​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt, ApiCallback _callback)
      Build call for finalizeQuery
      ApiResponse<Query> finalizeQueryWithHttpInfo​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt)
      send a query to run against a specified array/URI registered to a group/project
      ApiClient getApiClient()  
      java.lang.String getCustomBaseUrl()  
      Query getEstResultSizes​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt)
      send a query to run against a specified array/URI registered to a group/project
      okhttp3.Call getEstResultSizesAsync​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt, ApiCallback<Query> _callback)
      (asynchronously) send a query to run against a specified array/URI registered to a group/project
      okhttp3.Call getEstResultSizesCall​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt, ApiCallback _callback)
      Build call for getEstResultSizes
      ApiResponse<Query> getEstResultSizesWithHttpInfo​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt)
      send a query to run against a specified array/URI registered to a group/project
      java.io.File getFile​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, java.lang.String xPayer)
      send a query to run against a specified array/URI registered to a group/project, returns file bytes
      okhttp3.Call getFileAsync​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, java.lang.String xPayer, ApiCallback<java.io.File> _callback)
      (asynchronously) send a query to run against a specified array/URI registered to a group/project, returns file bytes
      okhttp3.Call getFileCall​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, java.lang.String xPayer, ApiCallback _callback)
      Build call for getFile
      ApiResponse<java.io.File> getFileWithHttpInfo​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, java.lang.String xPayer)
      send a query to run against a specified array/URI registered to a group/project, returns file bytes
      int getHostIndex()  
      void setApiClient​(ApiClient apiClient)  
      void setCustomBaseUrl​(java.lang.String customBaseUrl)  
      void setHostIndex​(int hostIndex)  
      Query submitQuery​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt)
      send a query to run against a specified array/URI registered to a group/project
      okhttp3.Call submitQueryAsync​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt, ApiCallback<Query> _callback)
      (asynchronously) send a query to run against a specified array/URI registered to a group/project
      okhttp3.Call submitQueryCall​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt, ApiCallback _callback)
      Build call for submitQuery
      java.lang.Object submitQueryJson​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, QueryJson queryJson, java.lang.String xPayer)
      send a query to run against a specified array/URI registered to a group/project, returns JSON results
      okhttp3.Call submitQueryJsonAsync​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, QueryJson queryJson, java.lang.String xPayer, ApiCallback<java.lang.Object> _callback)
      (asynchronously) send a query to run against a specified array/URI registered to a group/project, returns JSON results
      okhttp3.Call submitQueryJsonCall​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, QueryJson queryJson, java.lang.String xPayer, ApiCallback _callback)
      Build call for submitQueryJson
      ApiResponse<java.lang.Object> submitQueryJsonWithHttpInfo​(java.lang.String namespace, java.lang.String array, java.lang.String contentType, QueryJson queryJson, java.lang.String xPayer)
      send a query to run against a specified array/URI registered to a group/project, returns JSON results
      ApiResponse<Query> submitQueryWithHttpInfo​(java.lang.String namespace, java.lang.String array, java.lang.String type, java.lang.String contentType, Query query, java.lang.String xPayer, java.lang.Integer openAt)
      send a query to run against a specified array/URI registered to a group/project

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • QueryApi

        public QueryApi()

      • QueryApi

        public QueryApi​(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)

      • finalizeQueryCall

        public okhttp3.Call finalizeQueryCall​(java.lang.String namespace,
                                      java.lang.String array,
                                      java.lang.String type,
                                      java.lang.String contentType,
                                      Query query,
                                      java.lang.String xPayer,
                                      java.lang.Integer openAt,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for finalizeQuery
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • finalizeQuery

        public Query finalizeQuery​(java.lang.String namespace,
                           java.lang.String array,
                           java.lang.String type,
                           java.lang.String contentType,
                           Query query,
                           java.lang.String xPayer,
                           java.lang.Integer openAt)
                    throws ApiException
        send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        Returns:
        Query
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • finalizeQueryWithHttpInfo

        public ApiResponse<Query> finalizeQueryWithHttpInfo​(java.lang.String namespace,
                                                    java.lang.String array,
                                                    java.lang.String type,
                                                    java.lang.String contentType,
                                                    Query query,
                                                    java.lang.String xPayer,
                                                    java.lang.Integer openAt)
                                             throws ApiException
        send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        Returns:
        ApiResponse<Query>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • finalizeQueryAsync

        public okhttp3.Call finalizeQueryAsync​(java.lang.String namespace,
                                       java.lang.String array,
                                       java.lang.String type,
                                       java.lang.String contentType,
                                       Query query,
                                       java.lang.String xPayer,
                                       java.lang.Integer openAt,
                                       ApiCallback<Query> _callback)
                                throws ApiException
        (asynchronously) send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (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

      • getEstResultSizesCall

        public okhttp3.Call getEstResultSizesCall​(java.lang.String namespace,
                                          java.lang.String array,
                                          java.lang.String type,
                                          java.lang.String contentType,
                                          Query query,
                                          java.lang.String xPayer,
                                          java.lang.Integer openAt,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for getEstResultSizes
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getEstResultSizes

        public Query getEstResultSizes​(java.lang.String namespace,
                               java.lang.String array,
                               java.lang.String type,
                               java.lang.String contentType,
                               Query query,
                               java.lang.String xPayer,
                               java.lang.Integer openAt)
                        throws ApiException
        send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        Returns:
        Query
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEstResultSizesWithHttpInfo

        public ApiResponse<Query> getEstResultSizesWithHttpInfo​(java.lang.String namespace,
                                                        java.lang.String array,
                                                        java.lang.String type,
                                                        java.lang.String contentType,
                                                        Query query,
                                                        java.lang.String xPayer,
                                                        java.lang.Integer openAt)
                                                 throws ApiException
        send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        Returns:
        ApiResponse<Query>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getEstResultSizesAsync

        public okhttp3.Call getEstResultSizesAsync​(java.lang.String namespace,
                                           java.lang.String array,
                                           java.lang.String type,
                                           java.lang.String contentType,
                                           Query query,
                                           java.lang.String xPayer,
                                           java.lang.Integer openAt,
                                           ApiCallback<Query> _callback)
                                    throws ApiException
        (asynchronously) send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (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

      • getFileCall

        public okhttp3.Call getFileCall​(java.lang.String namespace,
                                java.lang.String array,
                                java.lang.String contentType,
                                java.lang.String xPayer,
                                ApiCallback _callback)
                         throws ApiException
        Build call for getFile
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getFile

        public java.io.File getFile​(java.lang.String namespace,
                            java.lang.String array,
                            java.lang.String contentType,
                            java.lang.String xPayer)
                     throws ApiException
        send a query to run against a specified array/URI registered to a group/project, returns file bytes
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFileWithHttpInfo

        public ApiResponse<java.io.File> getFileWithHttpInfo​(java.lang.String namespace,
                                                     java.lang.String array,
                                                     java.lang.String contentType,
                                                     java.lang.String xPayer)
                                              throws ApiException
        send a query to run against a specified array/URI registered to a group/project, returns file bytes
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getFileAsync

        public okhttp3.Call getFileAsync​(java.lang.String namespace,
                                 java.lang.String array,
                                 java.lang.String contentType,
                                 java.lang.String xPayer,
                                 ApiCallback<java.io.File> _callback)
                          throws ApiException
        (asynchronously) send a query to run against a specified array/URI registered to a group/project, returns file bytes
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        xPayer - Name of organization or user who should be charged for this request (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

      • submitQueryCall

        public okhttp3.Call submitQueryCall​(java.lang.String namespace,
                                    java.lang.String array,
                                    java.lang.String type,
                                    java.lang.String contentType,
                                    Query query,
                                    java.lang.String xPayer,
                                    java.lang.Integer openAt,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for submitQuery
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • submitQuery

        public Query submitQuery​(java.lang.String namespace,
                         java.lang.String array,
                         java.lang.String type,
                         java.lang.String contentType,
                         Query query,
                         java.lang.String xPayer,
                         java.lang.Integer openAt)
                  throws ApiException
        send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        Returns:
        Query
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitQueryWithHttpInfo

        public ApiResponse<Query> submitQueryWithHttpInfo​(java.lang.String namespace,
                                                  java.lang.String array,
                                                  java.lang.String type,
                                                  java.lang.String contentType,
                                                  Query query,
                                                  java.lang.String xPayer,
                                                  java.lang.Integer openAt)
                                           throws ApiException
        send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (optional)
        Returns:
        ApiResponse<Query>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitQueryAsync

        public okhttp3.Call submitQueryAsync​(java.lang.String namespace,
                                     java.lang.String array,
                                     java.lang.String type,
                                     java.lang.String contentType,
                                     Query query,
                                     java.lang.String xPayer,
                                     java.lang.Integer openAt,
                                     ApiCallback<Query> _callback)
                              throws ApiException
        (asynchronously) send a query to run against a specified array/URI registered to a group/project
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        type - type of query (required)
        contentType - Content Type of input and return mime (required)
        query - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        openAt - open_at for array in unix epoch (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

      • submitQueryJsonCall

        public okhttp3.Call submitQueryJsonCall​(java.lang.String namespace,
                                        java.lang.String array,
                                        java.lang.String contentType,
                                        QueryJson queryJson,
                                        java.lang.String xPayer,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for submitQueryJson
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        queryJson - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • submitQueryJson

        public java.lang.Object submitQueryJson​(java.lang.String namespace,
                                        java.lang.String array,
                                        java.lang.String contentType,
                                        QueryJson queryJson,
                                        java.lang.String xPayer)
                                 throws ApiException
        send a query to run against a specified array/URI registered to a group/project, returns JSON results
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        queryJson - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        Returns:
        Object
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitQueryJsonWithHttpInfo

        public ApiResponse<java.lang.Object> submitQueryJsonWithHttpInfo​(java.lang.String namespace,
                                                                 java.lang.String array,
                                                                 java.lang.String contentType,
                                                                 QueryJson queryJson,
                                                                 java.lang.String xPayer)
                                                          throws ApiException
        send a query to run against a specified array/URI registered to a group/project, returns JSON results
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        queryJson - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (optional)
        Returns:
        ApiResponse<Object>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • submitQueryJsonAsync

        public okhttp3.Call submitQueryJsonAsync​(java.lang.String namespace,
                                         java.lang.String array,
                                         java.lang.String contentType,
                                         QueryJson queryJson,
                                         java.lang.String xPayer,
                                         ApiCallback<java.lang.Object> _callback)
                                  throws ApiException
        (asynchronously) send a query to run against a specified array/URI registered to a group/project, returns JSON results
        Parameters:
        namespace - namespace array is in (an organization name or user's username) (required)
        array - name/uri of array that is url-encoded (required)
        contentType - Content Type of input and return mime (required)
        queryJson - query to run (required)
        xPayer - Name of organization or user who should be charged for this request (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