com.rockset.client.api

Class QueriesApi

java.lang.Object

com.rockset.client.api.QueriesApi

public class QueriesApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
QueriesApi()
QueriesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
QueryPaginationResponse	get(java.lang.String queryId, java.lang.String cursor, java.lang.Integer docs, java.lang.Integer offset) Fetch paginated query results
ApiClient	getApiClient()
com.squareup.okhttp.Call	getAsync(java.lang.String queryId, java.lang.String cursor, java.lang.Integer docs, java.lang.Integer offset, ApiCallback<QueryPaginationResponse> callback) Fetch paginated query results (asynchronously)
com.squareup.okhttp.Call	getCall(java.lang.String queryId, java.lang.String cursor, java.lang.Integer docs, java.lang.Integer offset, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for get
ApiResponse<QueryPaginationResponse>	getWithHttpInfo(java.lang.String queryId, java.lang.String cursor, java.lang.Integer docs, java.lang.Integer offset) Fetch paginated query results
QueryResponse	query(QueryRequest body) Query Make a SQL query to Rockset.
com.squareup.okhttp.Call	queryAsync(QueryRequest body, ApiCallback<QueryResponse> callback) Query (asynchronously) Make a SQL query to Rockset.
com.squareup.okhttp.Call	queryCall(QueryRequest body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for query
ApiResponse<QueryResponse>	queryWithHttpInfo(QueryRequest body) Query Make a SQL query to Rockset.
void	setApiClient(ApiClient apiClient)
ValidateQueryResponse	validate(QueryRequest body) Validate Query Validate a SQL query with Rockset's parser and planner.
com.squareup.okhttp.Call	validateAsync(QueryRequest body, ApiCallback<ValidateQueryResponse> callback) Validate Query (asynchronously) Validate a SQL query with Rockset's parser and planner.
com.squareup.okhttp.Call	validateCall(QueryRequest body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validate
ApiResponse<ValidateQueryResponse>	validateWithHttpInfo(QueryRequest body) Validate Query Validate a SQL query with Rockset's parser and planner.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueriesApi

public QueriesApi()

QueriesApi

public QueriesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCall

public com.squareup.okhttp.Call getCall(java.lang.String queryId,
                                        java.lang.String cursor,
                                        java.lang.Integer docs,
                                        java.lang.Integer offset,
                                        ProgressResponseBody.ProgressListener progressListener,
                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                 throws java.lang.Exception

Build call for get

Parameters:

queryId - (required)

cursor - (required)

docs - (optional)

offset - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

java.lang.Exception - If fail to serialize the request body object

get

public QueryPaginationResponse get(java.lang.String queryId,
                                   java.lang.String cursor,
                                   java.lang.Integer docs,
                                   java.lang.Integer offset)
                            throws java.lang.Exception

Fetch paginated query results

Parameters:

queryId - (required)

cursor - (required)

docs - (optional)

offset - (optional)

Returns:

QueryPaginationResponse

Throws:

java.lang.Exception - If fail to call the API, e.g. server error or cannot deserialize the response body

getWithHttpInfo

public ApiResponse<QueryPaginationResponse> getWithHttpInfo(java.lang.String queryId,
                                                            java.lang.String cursor,
                                                            java.lang.Integer docs,
                                                            java.lang.Integer offset)
                                                     throws java.lang.Exception

Fetch paginated query results

Parameters:

queryId - (required)

cursor - (required)

docs - (optional)

offset - (optional)

Returns:

ApiResponse<QueryPaginationResponse>

Throws:

java.lang.Exception - If fail to call the API, e.g. server error or cannot deserialize the response body

getAsync

public com.squareup.okhttp.Call getAsync(java.lang.String queryId,
                                         java.lang.String cursor,
                                         java.lang.Integer docs,
                                         java.lang.Integer offset,
                                         ApiCallback<QueryPaginationResponse> callback)
                                  throws java.lang.Exception

Fetch paginated query results (asynchronously)

Parameters:

queryId - (required)

cursor - (required)

docs - (optional)

offset - (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

java.lang.Exception - If fail to process the API call, e.g. serializing the request body object

queryCall

public com.squareup.okhttp.Call queryCall(QueryRequest body,
                                          ProgressResponseBody.ProgressListener progressListener,
                                          ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                   throws java.lang.Exception

Build call for query

Parameters:

body - JSON object (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

java.lang.Exception - If fail to serialize the request body object

query

public QueryResponse query(QueryRequest body)
                    throws java.lang.Exception

Query Make a SQL query to Rockset.

Parameters:

body - JSON object (required)

Returns:

QueryResponse

Throws:

java.lang.Exception - If fail to call the API, e.g. server error or cannot deserialize the response body

queryWithHttpInfo

public ApiResponse<QueryResponse> queryWithHttpInfo(QueryRequest body)
                                             throws java.lang.Exception

Query Make a SQL query to Rockset.

Parameters:

body - JSON object (required)

Returns:

ApiResponse<QueryResponse>

Throws:

java.lang.Exception - If fail to call the API, e.g. server error or cannot deserialize the response body

queryAsync

public com.squareup.okhttp.Call queryAsync(QueryRequest body,
                                           ApiCallback<QueryResponse> callback)
                                    throws java.lang.Exception

Query (asynchronously) Make a SQL query to Rockset.

Parameters:

body - JSON object (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

java.lang.Exception - If fail to process the API call, e.g. serializing the request body object

validateCall

public com.squareup.okhttp.Call validateCall(QueryRequest body,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws java.lang.Exception

Build call for validate

Parameters:

body - JSON object (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

java.lang.Exception - If fail to serialize the request body object

validate

public ValidateQueryResponse validate(QueryRequest body)
                               throws java.lang.Exception

Validate Query Validate a SQL query with Rockset's parser and planner.

Parameters:

body - JSON object (required)

Returns:

ValidateQueryResponse

Throws:

java.lang.Exception - If fail to call the API, e.g. server error or cannot deserialize the response body

validateWithHttpInfo

public ApiResponse<ValidateQueryResponse> validateWithHttpInfo(QueryRequest body)
                                                        throws java.lang.Exception

Validate Query Validate a SQL query with Rockset's parser and planner.

Parameters:

body - JSON object (required)

Returns:

ApiResponse<ValidateQueryResponse>

Throws:

java.lang.Exception - If fail to call the API, e.g. server error or cannot deserialize the response body

validateAsync

public com.squareup.okhttp.Call validateAsync(QueryRequest body,
                                              ApiCallback<ValidateQueryResponse> callback)
                                       throws java.lang.Exception

Validate Query (asynchronously) Validate a SQL query with Rockset's parser and planner.

Parameters:

body - JSON object (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

java.lang.Exception - If fail to process the API call, e.g. serializing the request body object