Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* FINBOURNE Luminesce Web API
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 1.13.202
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.finbourne.luminesce.api;
import com.finbourne.luminesce.ApiCallback;
import com.finbourne.luminesce.ApiClient;
import com.finbourne.luminesce.ApiException;
import com.finbourne.luminesce.ApiResponse;
import com.finbourne.luminesce.Configuration;
import com.finbourne.luminesce.Pair;
import com.finbourne.luminesce.ProgressRequestBody;
import com.finbourne.luminesce.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import com.finbourne.luminesce.model.LusidProblemDetails;
import com.finbourne.luminesce.model.QueryDesign;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class SqlExecutionApi {
private ApiClient localVarApiClient;
public SqlExecutionApi() {
this(Configuration.getDefaultApiClient());
}
public SqlExecutionApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for getByQueryCsv
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryCsvCall(String query, String queryName, Boolean download, Integer timeout, String delimiter, String escape, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/Sql/csv/{query}"
.replaceAll("\\{" + "query" + "\\}", localVarApiClient.escapeString(query.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (download != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("download", download));
}
if (timeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeout", timeout));
}
if (delimiter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("delimiter", delimiter));
}
if (escape != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("escape", escape));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getByQueryCsvValidateBeforeCall(String query, String queryName, Boolean download, Integer timeout, String delimiter, String escape, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'query' is set
if (query == null) {
throw new ApiException("Missing the required parameter 'query' when calling getByQueryCsv(Async)");
}
okhttp3.Call localVarCall = getByQueryCsvCall(query, queryName, download, timeout, delimiter, escape, _callback);
return localVarCall;
}
/**
* GetByQueryCsv: Executes Sql, returned in CSV format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String getByQueryCsv(String query, String queryName, Boolean download, Integer timeout, String delimiter, String escape) throws ApiException {
ApiResponse localVarResp = getByQueryCsvWithHttpInfo(query, queryName, download, timeout, delimiter, escape);
return localVarResp.getData();
}
/**
* GetByQueryCsv: Executes Sql, returned in CSV format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse getByQueryCsvWithHttpInfo(String query, String queryName, Boolean download, Integer timeout, String delimiter, String escape) throws ApiException {
okhttp3.Call localVarCall = getByQueryCsvValidateBeforeCall(query, queryName, download, timeout, delimiter, escape, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* GetByQueryCsv: Executes Sql, returned in CSV format, where the sql is simply in the url. (asynchronously)
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryCsvAsync(String query, String queryName, Boolean download, Integer timeout, String delimiter, String escape, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getByQueryCsvValidateBeforeCall(query, queryName, download, timeout, delimiter, escape, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getByQueryExcel
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryExcelCall(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/Sql/excel/{query}"
.replaceAll("\\{" + "query" + "\\}", localVarApiClient.escapeString(query.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeout", timeout));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getByQueryExcelValidateBeforeCall(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'query' is set
if (query == null) {
throw new ApiException("Missing the required parameter 'query' when calling getByQueryExcel(Async)");
}
okhttp3.Call localVarCall = getByQueryExcelCall(query, queryName, timeout, _callback);
return localVarCall;
}
/**
* GetByQueryExcel: Executes Sql, returned in Excel (xlsx) format (as a file to be downloaded) format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String getByQueryExcel(String query, String queryName, Integer timeout) throws ApiException {
ApiResponse localVarResp = getByQueryExcelWithHttpInfo(query, queryName, timeout);
return localVarResp.getData();
}
/**
* GetByQueryExcel: Executes Sql, returned in Excel (xlsx) format (as a file to be downloaded) format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse getByQueryExcelWithHttpInfo(String query, String queryName, Integer timeout) throws ApiException {
okhttp3.Call localVarCall = getByQueryExcelValidateBeforeCall(query, queryName, timeout, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* GetByQueryExcel: Executes Sql, returned in Excel (xlsx) format (as a file to be downloaded) format, where the sql is simply in the url. (asynchronously)
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryExcelAsync(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getByQueryExcelValidateBeforeCall(query, queryName, timeout, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getByQueryJson
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryJsonCall(String query, String queryName, Integer timeout, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/Sql/json/{query}"
.replaceAll("\\{" + "query" + "\\}", localVarApiClient.escapeString(query.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeout", timeout));
}
if (jsonProper != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("jsonProper", jsonProper));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getByQueryJsonValidateBeforeCall(String query, String queryName, Integer timeout, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'query' is set
if (query == null) {
throw new ApiException("Missing the required parameter 'query' when calling getByQueryJson(Async)");
}
okhttp3.Call localVarCall = getByQueryJsonCall(query, queryName, timeout, jsonProper, _callback);
return localVarCall;
}
/**
* GetByQueryJson: Executes Sql, returned in JSON format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String getByQueryJson(String query, String queryName, Integer timeout, Boolean jsonProper) throws ApiException {
ApiResponse localVarResp = getByQueryJsonWithHttpInfo(query, queryName, timeout, jsonProper);
return localVarResp.getData();
}
/**
* GetByQueryJson: Executes Sql, returned in JSON format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse getByQueryJsonWithHttpInfo(String query, String queryName, Integer timeout, Boolean jsonProper) throws ApiException {
okhttp3.Call localVarCall = getByQueryJsonValidateBeforeCall(query, queryName, timeout, jsonProper, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* GetByQueryJson: Executes Sql, returned in JSON format, where the sql is simply in the url. (asynchronously)
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryJsonAsync(String query, String queryName, Integer timeout, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getByQueryJsonValidateBeforeCall(query, queryName, timeout, jsonProper, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getByQueryParquet
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryParquetCall(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/Sql/parquet/{query}"
.replaceAll("\\{" + "query" + "\\}", localVarApiClient.escapeString(query.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeout", timeout));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getByQueryParquetValidateBeforeCall(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'query' is set
if (query == null) {
throw new ApiException("Missing the required parameter 'query' when calling getByQueryParquet(Async)");
}
okhttp3.Call localVarCall = getByQueryParquetCall(query, queryName, timeout, _callback);
return localVarCall;
}
/**
* GetByQueryParquet: Executes Sql, returned in Parquet (.parquet) format (as a file to be downloaded) format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String getByQueryParquet(String query, String queryName, Integer timeout) throws ApiException {
ApiResponse localVarResp = getByQueryParquetWithHttpInfo(query, queryName, timeout);
return localVarResp.getData();
}
/**
* GetByQueryParquet: Executes Sql, returned in Parquet (.parquet) format (as a file to be downloaded) format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse getByQueryParquetWithHttpInfo(String query, String queryName, Integer timeout) throws ApiException {
okhttp3.Call localVarCall = getByQueryParquetValidateBeforeCall(query, queryName, timeout, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* GetByQueryParquet: Executes Sql, returned in Parquet (.parquet) format (as a file to be downloaded) format, where the sql is simply in the url. (asynchronously)
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryParquetAsync(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getByQueryParquetValidateBeforeCall(query, queryName, timeout, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getByQueryPipe
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryPipeCall(String query, String queryName, Boolean download, Integer timeout, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/Sql/pipe/{query}"
.replaceAll("\\{" + "query" + "\\}", localVarApiClient.escapeString(query.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (download != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("download", download));
}
if (timeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeout", timeout));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getByQueryPipeValidateBeforeCall(String query, String queryName, Boolean download, Integer timeout, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'query' is set
if (query == null) {
throw new ApiException("Missing the required parameter 'query' when calling getByQueryPipe(Async)");
}
okhttp3.Call localVarCall = getByQueryPipeCall(query, queryName, download, timeout, _callback);
return localVarCall;
}
/**
* GetByQueryPipe: Executes Sql, returned in pipe-delimited format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String getByQueryPipe(String query, String queryName, Boolean download, Integer timeout) throws ApiException {
ApiResponse localVarResp = getByQueryPipeWithHttpInfo(query, queryName, download, timeout);
return localVarResp.getData();
}
/**
* GetByQueryPipe: Executes Sql, returned in pipe-delimited format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse getByQueryPipeWithHttpInfo(String query, String queryName, Boolean download, Integer timeout) throws ApiException {
okhttp3.Call localVarCall = getByQueryPipeValidateBeforeCall(query, queryName, download, timeout, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* GetByQueryPipe: Executes Sql, returned in pipe-delimited format, where the sql is simply in the url. (asynchronously)
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryPipeAsync(String query, String queryName, Boolean download, Integer timeout, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getByQueryPipeValidateBeforeCall(query, queryName, download, timeout, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getByQuerySqlite
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQuerySqliteCall(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/Sql/sqlite/{query}"
.replaceAll("\\{" + "query" + "\\}", localVarApiClient.escapeString(query.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeout", timeout));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getByQuerySqliteValidateBeforeCall(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'query' is set
if (query == null) {
throw new ApiException("Missing the required parameter 'query' when calling getByQuerySqlite(Async)");
}
okhttp3.Call localVarCall = getByQuerySqliteCall(query, queryName, timeout, _callback);
return localVarCall;
}
/**
* GetByQuerySqlite: Executes Sql, returned in SqLite DB (sqlite3) format (as a file to be downloaded) format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String getByQuerySqlite(String query, String queryName, Integer timeout) throws ApiException {
ApiResponse localVarResp = getByQuerySqliteWithHttpInfo(query, queryName, timeout);
return localVarResp.getData();
}
/**
* GetByQuerySqlite: Executes Sql, returned in SqLite DB (sqlite3) format (as a file to be downloaded) format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse getByQuerySqliteWithHttpInfo(String query, String queryName, Integer timeout) throws ApiException {
okhttp3.Call localVarCall = getByQuerySqliteValidateBeforeCall(query, queryName, timeout, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* GetByQuerySqlite: Executes Sql, returned in SqLite DB (sqlite3) format (as a file to be downloaded) format, where the sql is simply in the url. (asynchronously)
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQuerySqliteAsync(String query, String queryName, Integer timeout, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getByQuerySqliteValidateBeforeCall(query, queryName, timeout, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getByQueryXml
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryXmlCall(String query, String queryName, Boolean download, Integer timeout, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/Sql/xml/{query}"
.replaceAll("\\{" + "query" + "\\}", localVarApiClient.escapeString(query.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (download != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("download", download));
}
if (timeout != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeout", timeout));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getByQueryXmlValidateBeforeCall(String query, String queryName, Boolean download, Integer timeout, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'query' is set
if (query == null) {
throw new ApiException("Missing the required parameter 'query' when calling getByQueryXml(Async)");
}
okhttp3.Call localVarCall = getByQueryXmlCall(query, queryName, download, timeout, _callback);
return localVarCall;
}
/**
* GetByQueryXml: Executes Sql, returned in Xml format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String getByQueryXml(String query, String queryName, Boolean download, Integer timeout) throws ApiException {
ApiResponse localVarResp = getByQueryXmlWithHttpInfo(query, queryName, download, timeout);
return localVarResp.getData();
}
/**
* GetByQueryXml: Executes Sql, returned in Xml format, where the sql is simply in the url.
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse getByQueryXmlWithHttpInfo(String query, String queryName, Boolean download, Integer timeout) throws ApiException {
okhttp3.Call localVarCall = getByQueryXmlValidateBeforeCall(query, queryName, download, timeout, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* GetByQueryXml: Executes Sql, returned in Xml format, where the sql is simply in the url. (asynchronously)
* For simple single-line query execution via the url. e.g. `select ^ from Sys.Field order by 1, 2` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param query LuminesceSql to Execute (must be one line only) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeout In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call getByQueryXmlAsync(String query, String queryName, Boolean download, Integer timeout, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getByQueryXmlValidateBeforeCall(query, queryName, download, timeout, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putByQueryCsv
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryCsvCall(String body, String queryName, Boolean download, Integer timeoutSeconds, String delimiter, String escape, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/csv";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (download != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("download", download));
}
if (timeoutSeconds != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeoutSeconds", timeoutSeconds));
}
if (delimiter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("delimiter", delimiter));
}
if (escape != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("escape", escape));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putByQueryCsvValidateBeforeCall(String body, String queryName, Boolean download, Integer timeoutSeconds, String delimiter, String escape, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putByQueryCsv(Async)");
}
okhttp3.Call localVarCall = putByQueryCsvCall(body, queryName, download, timeoutSeconds, delimiter, escape, _callback);
return localVarCall;
}
/**
* PutByQueryCsv: Executes Sql, returned in CSV format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putByQueryCsv(String body, String queryName, Boolean download, Integer timeoutSeconds, String delimiter, String escape) throws ApiException {
ApiResponse localVarResp = putByQueryCsvWithHttpInfo(body, queryName, download, timeoutSeconds, delimiter, escape);
return localVarResp.getData();
}
/**
* PutByQueryCsv: Executes Sql, returned in CSV format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putByQueryCsvWithHttpInfo(String body, String queryName, Boolean download, Integer timeoutSeconds, String delimiter, String escape) throws ApiException {
okhttp3.Call localVarCall = putByQueryCsvValidateBeforeCall(body, queryName, download, timeoutSeconds, delimiter, escape, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutByQueryCsv: Executes Sql, returned in CSV format, where the sql is the post-body url. (asynchronously)
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param delimiter Delimiter string to override the default (optional)
* @param escape Escape character to override the default (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryCsvAsync(String body, String queryName, Boolean download, Integer timeoutSeconds, String delimiter, String escape, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putByQueryCsvValidateBeforeCall(body, queryName, download, timeoutSeconds, delimiter, escape, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putByQueryExcel
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryExcelCall(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/excel";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeoutSeconds != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeoutSeconds", timeoutSeconds));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putByQueryExcelValidateBeforeCall(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putByQueryExcel(Async)");
}
okhttp3.Call localVarCall = putByQueryExcelCall(body, queryName, timeoutSeconds, _callback);
return localVarCall;
}
/**
* PutByQueryExcel: Executes Sql, returned in Excel (xlsx) format (as a file to be downloaded), where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putByQueryExcel(String body, String queryName, Integer timeoutSeconds) throws ApiException {
ApiResponse localVarResp = putByQueryExcelWithHttpInfo(body, queryName, timeoutSeconds);
return localVarResp.getData();
}
/**
* PutByQueryExcel: Executes Sql, returned in Excel (xlsx) format (as a file to be downloaded), where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putByQueryExcelWithHttpInfo(String body, String queryName, Integer timeoutSeconds) throws ApiException {
okhttp3.Call localVarCall = putByQueryExcelValidateBeforeCall(body, queryName, timeoutSeconds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutByQueryExcel: Executes Sql, returned in Excel (xlsx) format (as a file to be downloaded), where the sql is the post-body url. (asynchronously)
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryExcelAsync(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putByQueryExcelValidateBeforeCall(body, queryName, timeoutSeconds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putByQueryJson
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryJsonCall(String body, String queryName, Integer timeoutSeconds, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/json";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeoutSeconds != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeoutSeconds", timeoutSeconds));
}
if (jsonProper != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("jsonProper", jsonProper));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putByQueryJsonValidateBeforeCall(String body, String queryName, Integer timeoutSeconds, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putByQueryJson(Async)");
}
okhttp3.Call localVarCall = putByQueryJsonCall(body, queryName, timeoutSeconds, jsonProper, _callback);
return localVarCall;
}
/**
* PutByQueryJson: Executes Sql, returned in JSON format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putByQueryJson(String body, String queryName, Integer timeoutSeconds, Boolean jsonProper) throws ApiException {
ApiResponse localVarResp = putByQueryJsonWithHttpInfo(body, queryName, timeoutSeconds, jsonProper);
return localVarResp.getData();
}
/**
* PutByQueryJson: Executes Sql, returned in JSON format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putByQueryJsonWithHttpInfo(String body, String queryName, Integer timeoutSeconds, Boolean jsonProper) throws ApiException {
okhttp3.Call localVarCall = putByQueryJsonValidateBeforeCall(body, queryName, timeoutSeconds, jsonProper, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutByQueryJson: Executes Sql, returned in JSON format, where the sql is the post-body url. (asynchronously)
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryJsonAsync(String body, String queryName, Integer timeoutSeconds, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putByQueryJsonValidateBeforeCall(body, queryName, timeoutSeconds, jsonProper, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putByQueryParquet
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryParquetCall(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/parquet";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeoutSeconds != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeoutSeconds", timeoutSeconds));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putByQueryParquetValidateBeforeCall(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putByQueryParquet(Async)");
}
okhttp3.Call localVarCall = putByQueryParquetCall(body, queryName, timeoutSeconds, _callback);
return localVarCall;
}
/**
* PutByQueryParquet: Executes Sql, returned in Parquet format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putByQueryParquet(String body, String queryName, Integer timeoutSeconds) throws ApiException {
ApiResponse localVarResp = putByQueryParquetWithHttpInfo(body, queryName, timeoutSeconds);
return localVarResp.getData();
}
/**
* PutByQueryParquet: Executes Sql, returned in Parquet format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putByQueryParquetWithHttpInfo(String body, String queryName, Integer timeoutSeconds) throws ApiException {
okhttp3.Call localVarCall = putByQueryParquetValidateBeforeCall(body, queryName, timeoutSeconds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutByQueryParquet: Executes Sql, returned in Parquet format, where the sql is the post-body url. (asynchronously)
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryParquetAsync(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putByQueryParquetValidateBeforeCall(body, queryName, timeoutSeconds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putByQueryPipe
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryPipeCall(String body, String queryName, Boolean download, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/pipe";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (download != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("download", download));
}
if (timeoutSeconds != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeoutSeconds", timeoutSeconds));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putByQueryPipeValidateBeforeCall(String body, String queryName, Boolean download, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putByQueryPipe(Async)");
}
okhttp3.Call localVarCall = putByQueryPipeCall(body, queryName, download, timeoutSeconds, _callback);
return localVarCall;
}
/**
* PutByQueryPipe: Executes Sql, returned in pipe-delimited format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putByQueryPipe(String body, String queryName, Boolean download, Integer timeoutSeconds) throws ApiException {
ApiResponse localVarResp = putByQueryPipeWithHttpInfo(body, queryName, download, timeoutSeconds);
return localVarResp.getData();
}
/**
* PutByQueryPipe: Executes Sql, returned in pipe-delimited format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putByQueryPipeWithHttpInfo(String body, String queryName, Boolean download, Integer timeoutSeconds) throws ApiException {
okhttp3.Call localVarCall = putByQueryPipeValidateBeforeCall(body, queryName, download, timeoutSeconds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutByQueryPipe: Executes Sql, returned in pipe-delimited format, where the sql is the post-body url. (asynchronously)
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryPipeAsync(String body, String queryName, Boolean download, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putByQueryPipeValidateBeforeCall(body, queryName, download, timeoutSeconds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putByQuerySqlite
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQuerySqliteCall(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/sqlite";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (timeoutSeconds != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeoutSeconds", timeoutSeconds));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putByQuerySqliteValidateBeforeCall(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putByQuerySqlite(Async)");
}
okhttp3.Call localVarCall = putByQuerySqliteCall(body, queryName, timeoutSeconds, _callback);
return localVarCall;
}
/**
* PutByQuerySqlite: Executes Sql, returned in SqLite DB (sqlite3) format (as a file to be downloaded), where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putByQuerySqlite(String body, String queryName, Integer timeoutSeconds) throws ApiException {
ApiResponse localVarResp = putByQuerySqliteWithHttpInfo(body, queryName, timeoutSeconds);
return localVarResp.getData();
}
/**
* PutByQuerySqlite: Executes Sql, returned in SqLite DB (sqlite3) format (as a file to be downloaded), where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putByQuerySqliteWithHttpInfo(String body, String queryName, Integer timeoutSeconds) throws ApiException {
okhttp3.Call localVarCall = putByQuerySqliteValidateBeforeCall(body, queryName, timeoutSeconds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutByQuerySqlite: Executes Sql, returned in SqLite DB (sqlite3) format (as a file to be downloaded), where the sql is the post-body url. (asynchronously)
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQuerySqliteAsync(String body, String queryName, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putByQuerySqliteValidateBeforeCall(body, queryName, timeoutSeconds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putByQueryXml
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryXmlCall(String body, String queryName, Boolean download, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/xml";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (queryName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("queryName", queryName));
}
if (download != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("download", download));
}
if (timeoutSeconds != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("timeoutSeconds", timeoutSeconds));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putByQueryXmlValidateBeforeCall(String body, String queryName, Boolean download, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putByQueryXml(Async)");
}
okhttp3.Call localVarCall = putByQueryXmlCall(body, queryName, download, timeoutSeconds, _callback);
return localVarCall;
}
/**
* PutByQueryXml: Executes Sql, returned in Xml format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putByQueryXml(String body, String queryName, Boolean download, Integer timeoutSeconds) throws ApiException {
ApiResponse localVarResp = putByQueryXmlWithHttpInfo(body, queryName, download, timeoutSeconds);
return localVarResp.getData();
}
/**
* PutByQueryXml: Executes Sql, returned in Xml format, where the sql is the post-body url.
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putByQueryXmlWithHttpInfo(String body, String queryName, Boolean download, Integer timeoutSeconds) throws ApiException {
okhttp3.Call localVarCall = putByQueryXmlValidateBeforeCall(body, queryName, download, timeoutSeconds, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutByQueryXml: Executes Sql, returned in Xml format, where the sql is the post-body url. (asynchronously)
* For more complex LuminesceSql a PUT will allow for longer Sql. e.g.: ```sql @@cutoff = select #2020-02-01#; @issues = select Id, SortId, Summary, Created, Updated from Dev.Jira.Issue where Project='HC' and Created < @@cutoff and Updated > @@cutoff; select i.Id, i.SortId, i.Summary, LinkText, LinkedIssueId, LinkedIssueSortId, LinkedIssueSummary from @issues i inner join Dev.Jira.Issue.Link li on i.Id = li.IssueId ``` The following error codes are to be anticipated with standard Problem Detail reports: - 400 BadRequest - something failed with the execution or parsing of your query - 401 Unauthorized
* @param body LuminesceSql to Execute (may be multi-line) (required)
* @param queryName Name to apply to the query in logs and `Sys.Logs.HcQueryStart` (optional)
* @param download Makes this a file-download request (as opposed to returning the data in the response-body) (optional, default to false)
* @param timeoutSeconds In seconds: <0 → ∞, 0 → 120s (optional, default to 0)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putByQueryXmlAsync(String body, String queryName, Boolean download, Integer timeoutSeconds, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putByQueryXmlValidateBeforeCall(body, queryName, download, timeoutSeconds, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putQueryDesignToSql
* @param queryDesign Structured Query design object to generate SQL from (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putQueryDesignToSqlCall(QueryDesign queryDesign, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = queryDesign;
// create path and map variables
String localVarPath = "/api/Sql/fromdesign";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/json-patch+json", "application/json", "text/json", "application/_*+json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putQueryDesignToSqlValidateBeforeCall(QueryDesign queryDesign, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'queryDesign' is set
if (queryDesign == null) {
throw new ApiException("Missing the required parameter 'queryDesign' when calling putQueryDesignToSql(Async)");
}
okhttp3.Call localVarCall = putQueryDesignToSqlCall(queryDesign, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] PutQueryDesignToSql: Generates SQL from a structured query design
* SQL Designer specification to generate SQL from
* @param queryDesign Structured Query design object to generate SQL from (required)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putQueryDesignToSql(QueryDesign queryDesign) throws ApiException {
ApiResponse localVarResp = putQueryDesignToSqlWithHttpInfo(queryDesign);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] PutQueryDesignToSql: Generates SQL from a structured query design
* SQL Designer specification to generate SQL from
* @param queryDesign Structured Query design object to generate SQL from (required)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putQueryDesignToSqlWithHttpInfo(QueryDesign queryDesign) throws ApiException {
okhttp3.Call localVarCall = putQueryDesignToSqlValidateBeforeCall(queryDesign, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] PutQueryDesignToSql: Generates SQL from a structured query design (asynchronously)
* SQL Designer specification to generate SQL from
* @param queryDesign Structured Query design object to generate SQL from (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putQueryDesignToSqlAsync(QueryDesign queryDesign, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putQueryDesignToSqlValidateBeforeCall(queryDesign, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putQueryToFormat
* @param body LuminesceSql to Pretty-Print. Even if it doesn't parse an attempt will be made to format it (required)
* @param trailingCommas Should commas be after an expression (as opposed to before) (optional, default to true)
* @param uppercaseKeywords Should key words be capitalized (optional, default to false)
* @param breakJoinOnSections Should clauses on joins be given line breaks? (optional, default to true)
* @param spaceAfterExpandedComma Should comma-lists have spaces after the commas? (optional, default to true)
* @param keywordStandardization Should the \"nicest\" key words be used? (e.g. JOIN -> INNER JOIN) (optional, default to true)
* @param expandCommaLists Should comma-lists (e.g. select a,b,c) have line breaks added? (optional, default to false)
* @param expandInLists Should IN-lists have line breaks added? (optional, default to false)
* @param expandBooleanExpressions Should boolean expressions have line breaks added? (optional, default to true)
* @param expandBetweenConditions Should between conditions have line breaks added? (optional, default to true)
* @param expandCaseStatements Should case-statements have line breaks added? (optional, default to true)
* @param maxLineWidth Maximum number of characters to allow on one line (if possible) (optional, default to 120)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putQueryToFormatCall(String body, Boolean trailingCommas, Boolean uppercaseKeywords, Boolean breakJoinOnSections, Boolean spaceAfterExpandedComma, Boolean keywordStandardization, Boolean expandCommaLists, Boolean expandInLists, Boolean expandBooleanExpressions, Boolean expandBetweenConditions, Boolean expandCaseStatements, Integer maxLineWidth, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/pretty";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (trailingCommas != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("trailingCommas", trailingCommas));
}
if (uppercaseKeywords != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("uppercaseKeywords", uppercaseKeywords));
}
if (breakJoinOnSections != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("breakJoinOnSections", breakJoinOnSections));
}
if (spaceAfterExpandedComma != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("spaceAfterExpandedComma", spaceAfterExpandedComma));
}
if (keywordStandardization != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("keywordStandardization", keywordStandardization));
}
if (expandCommaLists != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("expandCommaLists", expandCommaLists));
}
if (expandInLists != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("expandInLists", expandInLists));
}
if (expandBooleanExpressions != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("expandBooleanExpressions", expandBooleanExpressions));
}
if (expandBetweenConditions != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("expandBetweenConditions", expandBetweenConditions));
}
if (expandCaseStatements != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("expandCaseStatements", expandCaseStatements));
}
if (maxLineWidth != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("maxLineWidth", maxLineWidth));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putQueryToFormatValidateBeforeCall(String body, Boolean trailingCommas, Boolean uppercaseKeywords, Boolean breakJoinOnSections, Boolean spaceAfterExpandedComma, Boolean keywordStandardization, Boolean expandCommaLists, Boolean expandInLists, Boolean expandBooleanExpressions, Boolean expandBetweenConditions, Boolean expandCaseStatements, Integer maxLineWidth, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putQueryToFormat(Async)");
}
okhttp3.Call localVarCall = putQueryToFormatCall(body, trailingCommas, uppercaseKeywords, breakJoinOnSections, spaceAfterExpandedComma, keywordStandardization, expandCommaLists, expandInLists, expandBooleanExpressions, expandBetweenConditions, expandCaseStatements, maxLineWidth, _callback);
return localVarCall;
}
/**
* PutQueryToFormat: Executes Sql, returned in JSON format, where the sql is the post-body url.
* This formats SQL (given a set of options as to how to do so). It takes some SQL (or a fragment thereof, it need not fully parse as yet and certainly need not execute correctly) and returns the reformatted version. e.g. ```sql select x,y,z from a inner join b on a.x=b.x where x>y or y!=z ``` becomes ```sql select x, y, z from a inner join b on a.x = b.x where x > y or y != z ```
* @param body LuminesceSql to Pretty-Print. Even if it doesn't parse an attempt will be made to format it (required)
* @param trailingCommas Should commas be after an expression (as opposed to before) (optional, default to true)
* @param uppercaseKeywords Should key words be capitalized (optional, default to false)
* @param breakJoinOnSections Should clauses on joins be given line breaks? (optional, default to true)
* @param spaceAfterExpandedComma Should comma-lists have spaces after the commas? (optional, default to true)
* @param keywordStandardization Should the \"nicest\" key words be used? (e.g. JOIN -> INNER JOIN) (optional, default to true)
* @param expandCommaLists Should comma-lists (e.g. select a,b,c) have line breaks added? (optional, default to false)
* @param expandInLists Should IN-lists have line breaks added? (optional, default to false)
* @param expandBooleanExpressions Should boolean expressions have line breaks added? (optional, default to true)
* @param expandBetweenConditions Should between conditions have line breaks added? (optional, default to true)
* @param expandCaseStatements Should case-statements have line breaks added? (optional, default to true)
* @param maxLineWidth Maximum number of characters to allow on one line (if possible) (optional, default to 120)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public String putQueryToFormat(String body, Boolean trailingCommas, Boolean uppercaseKeywords, Boolean breakJoinOnSections, Boolean spaceAfterExpandedComma, Boolean keywordStandardization, Boolean expandCommaLists, Boolean expandInLists, Boolean expandBooleanExpressions, Boolean expandBetweenConditions, Boolean expandCaseStatements, Integer maxLineWidth) throws ApiException {
ApiResponse localVarResp = putQueryToFormatWithHttpInfo(body, trailingCommas, uppercaseKeywords, breakJoinOnSections, spaceAfterExpandedComma, keywordStandardization, expandCommaLists, expandInLists, expandBooleanExpressions, expandBetweenConditions, expandCaseStatements, maxLineWidth);
return localVarResp.getData();
}
/**
* PutQueryToFormat: Executes Sql, returned in JSON format, where the sql is the post-body url.
* This formats SQL (given a set of options as to how to do so). It takes some SQL (or a fragment thereof, it need not fully parse as yet and certainly need not execute correctly) and returns the reformatted version. e.g. ```sql select x,y,z from a inner join b on a.x=b.x where x>y or y!=z ``` becomes ```sql select x, y, z from a inner join b on a.x = b.x where x > y or y != z ```
* @param body LuminesceSql to Pretty-Print. Even if it doesn't parse an attempt will be made to format it (required)
* @param trailingCommas Should commas be after an expression (as opposed to before) (optional, default to true)
* @param uppercaseKeywords Should key words be capitalized (optional, default to false)
* @param breakJoinOnSections Should clauses on joins be given line breaks? (optional, default to true)
* @param spaceAfterExpandedComma Should comma-lists have spaces after the commas? (optional, default to true)
* @param keywordStandardization Should the \"nicest\" key words be used? (e.g. JOIN -> INNER JOIN) (optional, default to true)
* @param expandCommaLists Should comma-lists (e.g. select a,b,c) have line breaks added? (optional, default to false)
* @param expandInLists Should IN-lists have line breaks added? (optional, default to false)
* @param expandBooleanExpressions Should boolean expressions have line breaks added? (optional, default to true)
* @param expandBetweenConditions Should between conditions have line breaks added? (optional, default to true)
* @param expandCaseStatements Should case-statements have line breaks added? (optional, default to true)
* @param maxLineWidth Maximum number of characters to allow on one line (if possible) (optional, default to 120)
* @return ApiResponse<String>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public ApiResponse putQueryToFormatWithHttpInfo(String body, Boolean trailingCommas, Boolean uppercaseKeywords, Boolean breakJoinOnSections, Boolean spaceAfterExpandedComma, Boolean keywordStandardization, Boolean expandCommaLists, Boolean expandInLists, Boolean expandBooleanExpressions, Boolean expandBetweenConditions, Boolean expandCaseStatements, Integer maxLineWidth) throws ApiException {
okhttp3.Call localVarCall = putQueryToFormatValidateBeforeCall(body, trailingCommas, uppercaseKeywords, breakJoinOnSections, spaceAfterExpandedComma, keywordStandardization, expandCommaLists, expandInLists, expandBooleanExpressions, expandBetweenConditions, expandCaseStatements, maxLineWidth, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* PutQueryToFormat: Executes Sql, returned in JSON format, where the sql is the post-body url. (asynchronously)
* This formats SQL (given a set of options as to how to do so). It takes some SQL (or a fragment thereof, it need not fully parse as yet and certainly need not execute correctly) and returns the reformatted version. e.g. ```sql select x,y,z from a inner join b on a.x=b.x where x>y or y!=z ``` becomes ```sql select x, y, z from a inner join b on a.x = b.x where x > y or y != z ```
* @param body LuminesceSql to Pretty-Print. Even if it doesn't parse an attempt will be made to format it (required)
* @param trailingCommas Should commas be after an expression (as opposed to before) (optional, default to true)
* @param uppercaseKeywords Should key words be capitalized (optional, default to false)
* @param breakJoinOnSections Should clauses on joins be given line breaks? (optional, default to true)
* @param spaceAfterExpandedComma Should comma-lists have spaces after the commas? (optional, default to true)
* @param keywordStandardization Should the \"nicest\" key words be used? (e.g. JOIN -> INNER JOIN) (optional, default to true)
* @param expandCommaLists Should comma-lists (e.g. select a,b,c) have line breaks added? (optional, default to false)
* @param expandInLists Should IN-lists have line breaks added? (optional, default to false)
* @param expandBooleanExpressions Should boolean expressions have line breaks added? (optional, default to true)
* @param expandBetweenConditions Should between conditions have line breaks added? (optional, default to true)
* @param expandCaseStatements Should case-statements have line breaks added? (optional, default to true)
* @param maxLineWidth Maximum number of characters to allow on one line (if possible) (optional, default to 120)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putQueryToFormatAsync(String body, Boolean trailingCommas, Boolean uppercaseKeywords, Boolean breakJoinOnSections, Boolean spaceAfterExpandedComma, Boolean keywordStandardization, Boolean expandCommaLists, Boolean expandInLists, Boolean expandBooleanExpressions, Boolean expandBetweenConditions, Boolean expandCaseStatements, Integer maxLineWidth, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = putQueryToFormatValidateBeforeCall(body, trailingCommas, uppercaseKeywords, breakJoinOnSections, spaceAfterExpandedComma, keywordStandardization, expandCommaLists, expandInLists, expandBooleanExpressions, expandBetweenConditions, expandCaseStatements, maxLineWidth, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for putSqlToQueryDesign
* @param body SQL query to generate the design object from (required)
* @param validateWithMetadata Should the table be validated against the users' view of Sys.Field to fill in DataTypes, etc.? (optional, default to true)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
*/
public okhttp3.Call putSqlToQueryDesignCall(String body, Boolean validateWithMetadata, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = body;
// create path and map variables
String localVarPath = "/api/Sql/todesign";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (validateWithMetadata != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("validateWithMetadata", validateWithMetadata));
}
final String[] localVarAccepts = {
"text/plain", "application/json", "text/json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"text/plain"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
localVarHeaderParams.put("X-LUSID-SDK-Language", "Java");
localVarHeaderParams.put("X-LUSID-SDK-Version", "1.13.202");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call putSqlToQueryDesignValidateBeforeCall(String body, Boolean validateWithMetadata, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'body' is set
if (body == null) {
throw new ApiException("Missing the required parameter 'body' when calling putSqlToQueryDesign(Async)");
}
okhttp3.Call localVarCall = putSqlToQueryDesignCall(body, validateWithMetadata, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] PutSqlToQueryDesign: Generates a SQL-design object from SQL string, if possible.
* SQL to attempt to create a Design object from
* @param body SQL query to generate the design object from (required)
* @param validateWithMetadata Should the table be validated against the users' view of Sys.Field to fill in DataTypes, etc.? (optional, default to true)
* @return String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
