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
*
* 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.finbourne.luminesce.extensions.ConfigurationOptions;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import com.finbourne.luminesce.model.BackgroundQueryCancelResponse;
import com.finbourne.luminesce.model.BackgroundQueryProgressResponse;
import com.finbourne.luminesce.model.BackgroundQueryResponse;
import com.finbourne.luminesce.model.LusidProblemDetails;
import java.time.OffsetDateTime;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class HistoricallyExecutedQueriesApi {
private ApiClient localVarApiClient;
private int localHostIndex;
private String localCustomBaseUrl;
public HistoricallyExecutedQueriesApi() {
this(Configuration.getDefaultApiClient());
}
public HistoricallyExecutedQueriesApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public int getHostIndex() {
return localHostIndex;
}
public void setHostIndex(int hostIndex) {
this.localHostIndex = hostIndex;
}
public String getCustomBaseUrl() {
return localCustomBaseUrl;
}
public void setCustomBaseUrl(String customBaseUrl) {
this.localCustomBaseUrl = customBaseUrl;
}
private okhttp3.Call cancelHistoryCall(String executionId, final ApiCallback _callback) throws ApiException {
return cancelHistoryCall(executionId, _callback, new ConfigurationOptions());
}
private okhttp3.Call cancelHistoryCall(String executionId, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/History/{executionId}"
.replace("{" + "executionId" + "}", localVarApiClient.escapeString(executionId.toString()));
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 = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(basePath, localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback, opts);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call cancelHistoryValidateBeforeCall(String executionId, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException("Missing the required parameter 'executionId' when calling cancelHistory(Async)");
}
return cancelHistoryCall(executionId, _callback, opts);
}
private ApiResponse cancelHistoryWithHttpInfo(String executionId) throws ApiException {
okhttp3.Call localVarCall = cancelHistoryValidateBeforeCall(executionId, null, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private ApiResponse cancelHistoryWithHttpInfo(String executionId, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = cancelHistoryValidateBeforeCall(executionId, null, opts);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call cancelHistoryAsync(String executionId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = cancelHistoryValidateBeforeCall(executionId, _callback, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
private okhttp3.Call cancelHistoryAsync(String executionId, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = cancelHistoryValidateBeforeCall(executionId, _callback, opts);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class APIcancelHistoryRequest {
private final String executionId;
private APIcancelHistoryRequest(String executionId) {
this.executionId = executionId;
}
/**
* Build call for cancelHistory
* @param _callback ApiCallback API callback
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
*/
public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
return cancelHistoryCall(executionId, _callback);
}
/**
* Execute cancelHistory request
* @return BackgroundQueryCancelResponse
* @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
-
*/
public BackgroundQueryCancelResponse execute() throws ApiException {
ApiResponse localVarResp = cancelHistoryWithHttpInfo(executionId);
return localVarResp.getData();
}
/**
* Execute cancelHistory request. Use any specified configuration options to override any other configuration for this request only.
* @return BackgroundQueryCancelResponse
* @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
-
*/
public BackgroundQueryCancelResponse execute(ConfigurationOptions opts) throws ApiException {
ApiResponse localVarResp = cancelHistoryWithHttpInfo(executionId, opts);
return localVarResp.getData();
}
/**
* Execute cancelHistory request with HTTP info returned
* @return ApiResponse<BackgroundQueryCancelResponse>
* @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
-
*/
public ApiResponse executeWithHttpInfo() throws ApiException {
return cancelHistoryWithHttpInfo(executionId);
}
/**
* Execute cancelHistory request with HTTP info returned. Use any specified configuration options to override any other configuration for this request only.
* @return ApiResponse<BackgroundQueryCancelResponse>
* @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
-
*/
public ApiResponse executeWithHttpInfo(ConfigurationOptions opts) throws ApiException {
return cancelHistoryWithHttpInfo(executionId, opts);
}
/**
* Execute cancelHistory request (asynchronously)
* @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
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return cancelHistoryAsync(executionId, _callback);
}
/**
* Execute cancelHistory request (asynchronously). Use any specified configuration options to override any other configuration for this request only.
* @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
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
return cancelHistoryAsync(executionId, _callback, opts);
}
}
/**
* CancelHistory: Cancels / Clears data from a query history search
* Cancel the query (if still running) / clear the data (if already returned) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running.
* @param executionId ExecutionId returned when starting the query (required)
* @return APIcancelHistoryRequest
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
*/
public APIcancelHistoryRequest cancelHistory(String executionId) {
return new APIcancelHistoryRequest(executionId);
}
private okhttp3.Call fetchHistoryResultHistogramCall(String executionId, String bucketSize, String filter, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
return fetchHistoryResultHistogramCall(executionId, bucketSize, filter, jsonProper, _callback, new ConfigurationOptions());
}
private okhttp3.Call fetchHistoryResultHistogramCall(String executionId, String bucketSize, String filter, Boolean jsonProper, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/History/{executionId}/histogram"
.replace("{" + "executionId" + "}", localVarApiClient.escapeString(executionId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (bucketSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("bucketSize", bucketSize));
}
if (filter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter", filter));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback, opts);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call fetchHistoryResultHistogramValidateBeforeCall(String executionId, String bucketSize, String filter, Boolean jsonProper, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException("Missing the required parameter 'executionId' when calling fetchHistoryResultHistogram(Async)");
}
return fetchHistoryResultHistogramCall(executionId, bucketSize, filter, jsonProper, _callback, opts);
}
private ApiResponse fetchHistoryResultHistogramWithHttpInfo(String executionId, String bucketSize, String filter, Boolean jsonProper) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultHistogramValidateBeforeCall(executionId, bucketSize, filter, jsonProper, null, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private ApiResponse fetchHistoryResultHistogramWithHttpInfo(String executionId, String bucketSize, String filter, Boolean jsonProper, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultHistogramValidateBeforeCall(executionId, bucketSize, filter, jsonProper, null, opts);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call fetchHistoryResultHistogramAsync(String executionId, String bucketSize, String filter, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultHistogramValidateBeforeCall(executionId, bucketSize, filter, jsonProper, _callback, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
private okhttp3.Call fetchHistoryResultHistogramAsync(String executionId, String bucketSize, String filter, Boolean jsonProper, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultHistogramValidateBeforeCall(executionId, bucketSize, filter, jsonProper, _callback, opts);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class APIfetchHistoryResultHistogramRequest {
private final String executionId;
private String bucketSize;
private String filter;
private Boolean jsonProper;
private APIfetchHistoryResultHistogramRequest(String executionId) {
this.executionId = executionId;
}
/**
* Set bucketSize
* @param bucketSize Optional histogram bucket width. If not provided a set number of buckets between start/end range will be generated. (optional)
* @return APIfetchHistoryResultHistogramRequest
*/
public APIfetchHistoryResultHistogramRequest bucketSize(String bucketSize) {
this.bucketSize = bucketSize;
return this;
}
/**
* Set filter
* @param filter An ODATA filter per Finbourne.Filtering syntax. (optional)
* @return APIfetchHistoryResultHistogramRequest
*/
public APIfetchHistoryResultHistogramRequest filter(String filter) {
this.filter = filter;
return this;
}
/**
* Set jsonProper
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @return APIfetchHistoryResultHistogramRequest
*/
public APIfetchHistoryResultHistogramRequest jsonProper(Boolean jsonProper) {
this.jsonProper = jsonProper;
return this;
}
/**
* Build call for fetchHistoryResultHistogram
* @param _callback ApiCallback API callback
* @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
-
403
Forbidden
-
*/
public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
return fetchHistoryResultHistogramCall(executionId, bucketSize, filter, jsonProper, _callback);
}
/**
* Execute fetchHistoryResultHistogram request
* @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
-
403
Forbidden
-
*/
public String execute() throws ApiException {
ApiResponse localVarResp = fetchHistoryResultHistogramWithHttpInfo(executionId, bucketSize, filter, jsonProper);
return localVarResp.getData();
}
/**
* Execute fetchHistoryResultHistogram request. Use any specified configuration options to override any other configuration for this request only.
* @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
-
403
Forbidden
-
*/
public String execute(ConfigurationOptions opts) throws ApiException {
ApiResponse localVarResp = fetchHistoryResultHistogramWithHttpInfo(executionId, bucketSize, filter, jsonProper, opts);
return localVarResp.getData();
}
/**
* Execute fetchHistoryResultHistogram request with HTTP info returned
* @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
-
403
Forbidden
-
*/
public ApiResponse executeWithHttpInfo() throws ApiException {
return fetchHistoryResultHistogramWithHttpInfo(executionId, bucketSize, filter, jsonProper);
}
/**
* Execute fetchHistoryResultHistogram request with HTTP info returned. Use any specified configuration options to override any other configuration for this request only.
* @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
-
403
Forbidden
-
*/
public ApiResponse executeWithHttpInfo(ConfigurationOptions opts) throws ApiException {
return fetchHistoryResultHistogramWithHttpInfo(executionId, bucketSize, filter, jsonProper, opts);
}
/**
* Execute fetchHistoryResultHistogram request (asynchronously)
* @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
-
403
Forbidden
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return fetchHistoryResultHistogramAsync(executionId, bucketSize, filter, jsonProper, _callback);
}
/**
* Execute fetchHistoryResultHistogram request (asynchronously). Use any specified configuration options to override any other configuration for this request only.
* @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
-
403
Forbidden
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
return fetchHistoryResultHistogramAsync(executionId, bucketSize, filter, jsonProper, _callback, opts);
}
}
/**
* FetchHistoryResultHistogram: Makes a histogram of results from a query history search
* Fetch the histogram in Json format (if available, or if not simply being informed it is not yet ready) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request.
* @param executionId ExecutionId returned when starting the query (required)
* @return APIfetchHistoryResultHistogramRequest
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
403
Forbidden
-
*/
public APIfetchHistoryResultHistogramRequest fetchHistoryResultHistogram(String executionId) {
return new APIfetchHistoryResultHistogramRequest(executionId);
}
private okhttp3.Call fetchHistoryResultJsonCall(String executionId, String sortBy, String filter, String select, String groupBy, Integer limit, Integer page, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
return fetchHistoryResultJsonCall(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, _callback, new ConfigurationOptions());
}
private okhttp3.Call fetchHistoryResultJsonCall(String executionId, String sortBy, String filter, String select, String groupBy, Integer limit, Integer page, Boolean jsonProper, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/History/{executionId}/json"
.replace("{" + "executionId" + "}", localVarApiClient.escapeString(executionId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (sortBy != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("sortBy", sortBy));
}
if (filter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter", filter));
}
if (select != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("select", select));
}
if (groupBy != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("groupBy", groupBy));
}
if (limit != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit));
}
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback, opts);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call fetchHistoryResultJsonValidateBeforeCall(String executionId, String sortBy, String filter, String select, String groupBy, Integer limit, Integer page, Boolean jsonProper, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException("Missing the required parameter 'executionId' when calling fetchHistoryResultJson(Async)");
}
return fetchHistoryResultJsonCall(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, _callback, opts);
}
private ApiResponse fetchHistoryResultJsonWithHttpInfo(String executionId, String sortBy, String filter, String select, String groupBy, Integer limit, Integer page, Boolean jsonProper) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultJsonValidateBeforeCall(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, null, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private ApiResponse fetchHistoryResultJsonWithHttpInfo(String executionId, String sortBy, String filter, String select, String groupBy, Integer limit, Integer page, Boolean jsonProper, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultJsonValidateBeforeCall(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, null, opts);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call fetchHistoryResultJsonAsync(String executionId, String sortBy, String filter, String select, String groupBy, Integer limit, Integer page, Boolean jsonProper, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultJsonValidateBeforeCall(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, _callback, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
private okhttp3.Call fetchHistoryResultJsonAsync(String executionId, String sortBy, String filter, String select, String groupBy, Integer limit, Integer page, Boolean jsonProper, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = fetchHistoryResultJsonValidateBeforeCall(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, _callback, opts);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class APIfetchHistoryResultJsonRequest {
private final String executionId;
private String sortBy;
private String filter;
private String select;
private String groupBy;
private Integer limit;
private Integer page;
private Boolean jsonProper;
private APIfetchHistoryResultJsonRequest(String executionId) {
this.executionId = executionId;
}
/**
* Set sortBy
* @param sortBy Order the results by these fields. Use the `-` sign to denote descending order, e.g. `-MyFieldName`. Numeric indexes may be used also, e.g. `2,-3`. Multiple fields can be denoted by a comma e.g. `-MyFieldName,AnotherFieldName,-AFurtherFieldName`. Default is null, the sort order specified in the query itself. (optional)
* @return APIfetchHistoryResultJsonRequest
*/
public APIfetchHistoryResultJsonRequest sortBy(String sortBy) {
this.sortBy = sortBy;
return this;
}
/**
* Set filter
* @param filter An ODATA filter per Finbourne.Filtering syntax. (optional)
* @return APIfetchHistoryResultJsonRequest
*/
public APIfetchHistoryResultJsonRequest filter(String filter) {
this.filter = filter;
return this;
}
/**
* Set select
* @param select Default is null (meaning return all columns in the original query itself). The values are in terms of the result column name from the original data set and are comma delimited. The power of this comes in that you may aggregate the data if you wish (that is the main reason for allowing this, in fact). e.g.: - `MyField` - `Max(x) FILTER (WHERE y > 12) as ABC` (max of a field, if another field lets it qualify, with a nice column name) - `count(*)` (count the rows for the given group, that would produce a rather ugly column name, but it works) - `count(distinct x) as numOfXs` If there was an illegal character in a field you are selecting from, you are responsible for bracketing it with [ ]. e.g. - `some_field, count(*) as a, max(x) as b, min([column with space in name]) as nice_name` where you would likely want to pass `1` as the `groupBy` also. (optional)
* @return APIfetchHistoryResultJsonRequest
*/
public APIfetchHistoryResultJsonRequest select(String select) {
this.select = select;
return this;
}
/**
* Set groupBy
* @param groupBy Groups by the specified fields. A comma delimited list of: 1 based numeric indexes (cleaner), or repeats of the select expressions (a bit verbose and must match exactly). e.g. `2,3`, `myColumn`. Default is null (meaning no grouping will be performed on the selected columns). This applies only over the result set being requested here, meaning indexes into the \"select\" parameter fields. Only specify this if you are selecting aggregations in the \"select\" parameter. (optional)
* @return APIfetchHistoryResultJsonRequest
*/
public APIfetchHistoryResultJsonRequest groupBy(String groupBy) {
this.groupBy = groupBy;
return this;
}
/**
* Set limit
* @param limit When paginating, only return this number of records, page should also be specified. (optional, default to 0)
* @return APIfetchHistoryResultJsonRequest
*/
public APIfetchHistoryResultJsonRequest limit(Integer limit) {
this.limit = limit;
return this;
}
/**
* Set page
* @param page 0-N based on chunk sized determined by the limit, ignored if limit < 1. (optional, default to 0)
* @return APIfetchHistoryResultJsonRequest
*/
public APIfetchHistoryResultJsonRequest page(Integer page) {
this.page = page;
return this;
}
/**
* Set jsonProper
* @param jsonProper Should this be text/json (not json-encoded-as-a-string) (optional, default to false)
* @return APIfetchHistoryResultJsonRequest
*/
public APIfetchHistoryResultJsonRequest jsonProper(Boolean jsonProper) {
this.jsonProper = jsonProper;
return this;
}
/**
* Build call for fetchHistoryResultJson
* @param _callback ApiCallback API callback
* @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
-
403
Forbidden
-
*/
public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
return fetchHistoryResultJsonCall(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, _callback);
}
/**
* Execute fetchHistoryResultJson request
* @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
-
403
Forbidden
-
*/
public String execute() throws ApiException {
ApiResponse localVarResp = fetchHistoryResultJsonWithHttpInfo(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper);
return localVarResp.getData();
}
/**
* Execute fetchHistoryResultJson request. Use any specified configuration options to override any other configuration for this request only.
* @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
-
403
Forbidden
-
*/
public String execute(ConfigurationOptions opts) throws ApiException {
ApiResponse localVarResp = fetchHistoryResultJsonWithHttpInfo(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, opts);
return localVarResp.getData();
}
/**
* Execute fetchHistoryResultJson request with HTTP info returned
* @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
-
403
Forbidden
-
*/
public ApiResponse executeWithHttpInfo() throws ApiException {
return fetchHistoryResultJsonWithHttpInfo(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper);
}
/**
* Execute fetchHistoryResultJson request with HTTP info returned. Use any specified configuration options to override any other configuration for this request only.
* @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
-
403
Forbidden
-
*/
public ApiResponse executeWithHttpInfo(ConfigurationOptions opts) throws ApiException {
return fetchHistoryResultJsonWithHttpInfo(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, opts);
}
/**
* Execute fetchHistoryResultJson request (asynchronously)
* @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
-
403
Forbidden
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return fetchHistoryResultJsonAsync(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, _callback);
}
/**
* Execute fetchHistoryResultJson request (asynchronously). Use any specified configuration options to override any other configuration for this request only.
* @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
-
403
Forbidden
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
return fetchHistoryResultJsonAsync(executionId, sortBy, filter, select, groupBy, limit, page, jsonProper, _callback, opts);
}
}
/**
* FetchHistoryResultJson: Fetches JSON results from a query history search
* Fetch the data in Json format (if available, or if not simply being informed it is not yet ready) The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't (yet) exist. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request.
* @param executionId ExecutionId returned when starting the query (required)
* @return APIfetchHistoryResultJsonRequest
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
400
Bad Request
-
403
Forbidden
-
*/
public APIfetchHistoryResultJsonRequest fetchHistoryResultJson(String executionId) {
return new APIfetchHistoryResultJsonRequest(executionId);
}
private okhttp3.Call getHistoryCall(OffsetDateTime startAt, OffsetDateTime endAt, String freeTextSearch, Boolean showAll, Boolean mayUseNativeStore, final ApiCallback _callback) throws ApiException {
return getHistoryCall(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, _callback, new ConfigurationOptions());
}
private okhttp3.Call getHistoryCall(OffsetDateTime startAt, OffsetDateTime endAt, String freeTextSearch, Boolean showAll, Boolean mayUseNativeStore, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/History";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (startAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("startAt", startAt));
}
if (endAt != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("endAt", endAt));
}
if (freeTextSearch != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("freeTextSearch", freeTextSearch));
}
if (showAll != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("showAll", showAll));
}
if (mayUseNativeStore != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("mayUseNativeStore", mayUseNativeStore));
}
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);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback, opts);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getHistoryValidateBeforeCall(OffsetDateTime startAt, OffsetDateTime endAt, String freeTextSearch, Boolean showAll, Boolean mayUseNativeStore, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
return getHistoryCall(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, _callback, opts);
}
private ApiResponse getHistoryWithHttpInfo(OffsetDateTime startAt, OffsetDateTime endAt, String freeTextSearch, Boolean showAll, Boolean mayUseNativeStore) throws ApiException {
okhttp3.Call localVarCall = getHistoryValidateBeforeCall(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, null, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private ApiResponse getHistoryWithHttpInfo(OffsetDateTime startAt, OffsetDateTime endAt, String freeTextSearch, Boolean showAll, Boolean mayUseNativeStore, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = getHistoryValidateBeforeCall(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, null, opts);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call getHistoryAsync(OffsetDateTime startAt, OffsetDateTime endAt, String freeTextSearch, Boolean showAll, Boolean mayUseNativeStore, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getHistoryValidateBeforeCall(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, _callback, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
private okhttp3.Call getHistoryAsync(OffsetDateTime startAt, OffsetDateTime endAt, String freeTextSearch, Boolean showAll, Boolean mayUseNativeStore, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = getHistoryValidateBeforeCall(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, _callback, opts);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class APIgetHistoryRequest {
private OffsetDateTime startAt;
private OffsetDateTime endAt;
private String freeTextSearch;
private Boolean showAll;
private Boolean mayUseNativeStore;
private APIgetHistoryRequest() {
}
/**
* Set startAt
* @param startAt Date time to start the search from. Will default to Now - 1 Day (optional)
* @return APIgetHistoryRequest
*/
public APIgetHistoryRequest startAt(OffsetDateTime startAt) {
this.startAt = startAt;
return this;
}
/**
* Set endAt
* @param endAt Date time to end the search at. Defaults to now. (optional)
* @return APIgetHistoryRequest
*/
public APIgetHistoryRequest endAt(OffsetDateTime endAt) {
this.endAt = endAt;
return this;
}
/**
* Set freeTextSearch
* @param freeTextSearch Some test that must be in at least one field returned. (optional)
* @return APIgetHistoryRequest
*/
public APIgetHistoryRequest freeTextSearch(String freeTextSearch) {
this.freeTextSearch = freeTextSearch;
return this;
}
/**
* Set showAll
* @param showAll For users with extra permissions, they may optionally see other users' queries. (optional, default to false)
* @return APIgetHistoryRequest
*/
public APIgetHistoryRequest showAll(Boolean showAll) {
this.showAll = showAll;
return this;
}
/**
* Set mayUseNativeStore
* @param mayUseNativeStore Should a native data store (e.g. Athena or Fabric) be used over Elastic Search if available? (optional, default to true)
* @return APIgetHistoryRequest
*/
public APIgetHistoryRequest mayUseNativeStore(Boolean mayUseNativeStore) {
this.mayUseNativeStore = mayUseNativeStore;
return this;
}
/**
* Build call for getHistory
* @param _callback ApiCallback API callback
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
-
*/
public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
return getHistoryCall(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, _callback);
}
/**
* Execute getHistory request
* @return BackgroundQueryResponse
* @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
202
Accepted
-
*/
public BackgroundQueryResponse execute() throws ApiException {
ApiResponse localVarResp = getHistoryWithHttpInfo(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore);
return localVarResp.getData();
}
/**
* Execute getHistory request. Use any specified configuration options to override any other configuration for this request only.
* @return BackgroundQueryResponse
* @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
202
Accepted
-
*/
public BackgroundQueryResponse execute(ConfigurationOptions opts) throws ApiException {
ApiResponse localVarResp = getHistoryWithHttpInfo(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, opts);
return localVarResp.getData();
}
/**
* Execute getHistory request with HTTP info returned
* @return ApiResponse<BackgroundQueryResponse>
* @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
202
Accepted
-
*/
public ApiResponse executeWithHttpInfo() throws ApiException {
return getHistoryWithHttpInfo(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore);
}
/**
* Execute getHistory request with HTTP info returned. Use any specified configuration options to override any other configuration for this request only.
* @return ApiResponse<BackgroundQueryResponse>
* @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
202
Accepted
-
*/
public ApiResponse executeWithHttpInfo(ConfigurationOptions opts) throws ApiException {
return getHistoryWithHttpInfo(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, opts);
}
/**
* Execute getHistory request (asynchronously)
* @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
202
Accepted
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return getHistoryAsync(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, _callback);
}
/**
* Execute getHistory request (asynchronously). Use any specified configuration options to override any other configuration for this request only.
* @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
202
Accepted
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
return getHistoryAsync(startAt, endAt, freeTextSearch, showAll, mayUseNativeStore, _callback, opts);
}
}
/**
* GetHistory: Starts a background query history search
* Starts to load the historical query logs for a certain time range, search criteria, etc. The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden
* @return APIgetHistoryRequest
* @http.response.details
Status Code
Description
Response Headers
202
Accepted
-
*/
public APIgetHistoryRequest getHistory() {
return new APIgetHistoryRequest();
}
private okhttp3.Call getProgressOfHistoryCall(String executionId, final ApiCallback _callback) throws ApiException {
return getProgressOfHistoryCall(executionId, _callback, new ConfigurationOptions());
}
private okhttp3.Call getProgressOfHistoryCall(String executionId, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
String basePath = null;
// Operation Servers
String[] localBasePaths = new String[] { };
// Determine Base Path to Use
if (localCustomBaseUrl != null){
basePath = localCustomBaseUrl;
} else if ( localBasePaths.length > 0 ) {
basePath = localBasePaths[localHostIndex];
} else {
basePath = null;
}
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/History/{executionId}"
.replace("{" + "executionId" + "}", localVarApiClient.escapeString(executionId.toString()));
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 = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
if (localVarContentType != null) {
localVarHeaderParams.put("Content-Type", localVarContentType);
}
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(basePath, localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback, opts);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getProgressOfHistoryValidateBeforeCall(String executionId, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException("Missing the required parameter 'executionId' when calling getProgressOfHistory(Async)");
}
return getProgressOfHistoryCall(executionId, _callback, opts);
}
private ApiResponse getProgressOfHistoryWithHttpInfo(String executionId) throws ApiException {
okhttp3.Call localVarCall = getProgressOfHistoryValidateBeforeCall(executionId, null, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private ApiResponse getProgressOfHistoryWithHttpInfo(String executionId, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = getProgressOfHistoryValidateBeforeCall(executionId, null, opts);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
private okhttp3.Call getProgressOfHistoryAsync(String executionId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getProgressOfHistoryValidateBeforeCall(executionId, _callback, new ConfigurationOptions());
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
private okhttp3.Call getProgressOfHistoryAsync(String executionId, final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
okhttp3.Call localVarCall = getProgressOfHistoryValidateBeforeCall(executionId, _callback, opts);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
public class APIgetProgressOfHistoryRequest {
private final String executionId;
private APIgetProgressOfHistoryRequest(String executionId) {
this.executionId = executionId;
}
/**
* Build call for getProgressOfHistory
* @param _callback ApiCallback API callback
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
*/
public okhttp3.Call buildCall(final ApiCallback _callback) throws ApiException {
return getProgressOfHistoryCall(executionId, _callback);
}
/**
* Execute getProgressOfHistory request
* @return BackgroundQueryProgressResponse
* @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
-
*/
public BackgroundQueryProgressResponse execute() throws ApiException {
ApiResponse localVarResp = getProgressOfHistoryWithHttpInfo(executionId);
return localVarResp.getData();
}
/**
* Execute getProgressOfHistory request. Use any specified configuration options to override any other configuration for this request only.
* @return BackgroundQueryProgressResponse
* @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
-
*/
public BackgroundQueryProgressResponse execute(ConfigurationOptions opts) throws ApiException {
ApiResponse localVarResp = getProgressOfHistoryWithHttpInfo(executionId, opts);
return localVarResp.getData();
}
/**
* Execute getProgressOfHistory request with HTTP info returned
* @return ApiResponse<BackgroundQueryProgressResponse>
* @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
-
*/
public ApiResponse executeWithHttpInfo() throws ApiException {
return getProgressOfHistoryWithHttpInfo(executionId);
}
/**
* Execute getProgressOfHistory request with HTTP info returned. Use any specified configuration options to override any other configuration for this request only.
* @return ApiResponse<BackgroundQueryProgressResponse>
* @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
-
*/
public ApiResponse executeWithHttpInfo(ConfigurationOptions opts) throws ApiException {
return getProgressOfHistoryWithHttpInfo(executionId, opts);
}
/**
* Execute getProgressOfHistory request (asynchronously)
* @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
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback) throws ApiException {
return getProgressOfHistoryAsync(executionId, _callback);
}
/**
* Execute getProgressOfHistory request (asynchronously). Use any specified configuration options to override any other configuration for this request only.
* @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
-
*/
public okhttp3.Call executeAsync(final ApiCallback _callback, ConfigurationOptions opts) throws ApiException {
return getProgressOfHistoryAsync(executionId, _callback, opts);
}
}
/**
* GetProgressOfHistory: View progress of a query history search
* View progress information (up until this point) of previously started History query The following error codes are to be anticipated with standard Problem Detail reports: - 401 Unauthorized - 403 Forbidden - 404 Not Found : The requested query result doesn't exist and is not running. - 429 Too Many Requests : Please try your request again soon 1. The query has been executed successfully in the past yet the server-instance receiving this request (e.g. from a load balancer) doesn't yet have this data available. 1. By virtue of the request you have just placed this will have started to load from the persisted cache and will soon be available. 1. It is also the case that the original server-instance to process the original query is likely to already be able to service this request.
* @param executionId ExecutionId returned when starting the query (required)
* @return APIgetProgressOfHistoryRequest
* @http.response.details
Status Code
Description
Response Headers
200
Success
-
*/
public APIgetProgressOfHistoryRequest getProgressOfHistory(String executionId) {
return new APIgetProgressOfHistoryRequest(executionId);
}
}
