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 Scheduler API
* ### Introduction # Error Codes | Code|Name|Description | | ---|---|--- | | -1|Unknown error|An unexpected error was encountered on our side. | | 144|Duplicate In Parameter Set| | | 151|Invalid Parameter Value| | | 152|Action Execution Failure| | | 157|Invalid Request| | | 186|Access Denied| | | 187|Invalid Identity Token| | | 689|The supplied pagination token is invalid| | | 692|This endpoint does not support impersonation| | | 704|Cannot Delete Job| | | 731|Unable to process images associated with request.| | | 756|Image Scan Failure| | | 871|The specified impersonated user does not exist| |
*
* The version of the OpenAPI document: 0.0.936
* 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.scheduler.api;
import com.finbourne.scheduler.ApiCallback;
import com.finbourne.scheduler.ApiClient;
import com.finbourne.scheduler.ApiException;
import com.finbourne.scheduler.ApiResponse;
import com.finbourne.scheduler.Configuration;
import com.finbourne.scheduler.Pair;
import com.finbourne.scheduler.ProgressRequestBody;
import com.finbourne.scheduler.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import com.finbourne.scheduler.model.CreateJobRequest;
import com.finbourne.scheduler.model.JobDefinition;
import com.finbourne.scheduler.model.JobRunResult;
import com.finbourne.scheduler.model.LusidProblemDetails;
import com.finbourne.scheduler.model.LusidValidationProblemDetails;
import com.finbourne.scheduler.model.ResourceListOfJobDefinition;
import com.finbourne.scheduler.model.ResourceListOfJobHistory;
import com.finbourne.scheduler.model.ResourceListOfScheduleDefinition;
import com.finbourne.scheduler.model.StartJobRequest;
import com.finbourne.scheduler.model.StartJobResponse;
import com.finbourne.scheduler.model.UpdateJobRequest;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class JobsApi {
private ApiClient localVarApiClient;
public JobsApi() {
this(Configuration.getDefaultApiClient());
}
public JobsApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for createJob
* @param createJobRequest The request to create a new job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call createJobCall(CreateJobRequest createJobRequest, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = createJobRequest;
// create path and map variables
String localVarPath = "/api/jobs";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createJobValidateBeforeCall(CreateJobRequest createJobRequest, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'createJobRequest' is set
if (createJobRequest == null) {
throw new ApiException("Missing the required parameter 'createJobRequest' when calling createJob(Async)");
}
okhttp3.Call localVarCall = createJobCall(createJobRequest, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] CreateJob: Create a new job
*
* @param createJobRequest The request to create a new job (required)
* @return JobDefinition
* @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
The details of the input related failure
-
0
Error response
-
*/
public JobDefinition createJob(CreateJobRequest createJobRequest) throws ApiException {
ApiResponse localVarResp = createJobWithHttpInfo(createJobRequest);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] CreateJob: Create a new job
*
* @param createJobRequest The request to create a new job (required)
* @return ApiResponse<JobDefinition>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse createJobWithHttpInfo(CreateJobRequest createJobRequest) throws ApiException {
okhttp3.Call localVarCall = createJobValidateBeforeCall(createJobRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] CreateJob: Create a new job (asynchronously)
*
* @param createJobRequest The request to create a new job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call createJobAsync(CreateJobRequest createJobRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createJobValidateBeforeCall(createJobRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteJob
* @param scope The scope of the job (required)
* @param code The code of the job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call deleteJobCall(String scope, String code, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/jobs/{scope}/{code}"
.replaceAll("\\{" + "scope" + "\\}", localVarApiClient.escapeString(scope.toString()))
.replaceAll("\\{" + "code" + "\\}", localVarApiClient.escapeString(code.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteJobValidateBeforeCall(String scope, String code, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'scope' is set
if (scope == null) {
throw new ApiException("Missing the required parameter 'scope' when calling deleteJob(Async)");
}
// verify the required parameter 'code' is set
if (code == null) {
throw new ApiException("Missing the required parameter 'code' when calling deleteJob(Async)");
}
okhttp3.Call localVarCall = deleteJobCall(scope, code, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] DeleteJob: Delete a job
*
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @return ResourceListOfScheduleDefinition
* @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
The details of the input related failure
-
0
Error response
-
*/
public ResourceListOfScheduleDefinition deleteJob(String scope, String code) throws ApiException {
ApiResponse localVarResp = deleteJobWithHttpInfo(scope, code);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] DeleteJob: Delete a job
*
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @return ApiResponse<ResourceListOfScheduleDefinition>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse deleteJobWithHttpInfo(String scope, String code) throws ApiException {
okhttp3.Call localVarCall = deleteJobValidateBeforeCall(scope, code, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] DeleteJob: Delete a job (asynchronously)
*
* @param scope The scope of the job (required)
* @param code The code of the job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call deleteJobAsync(String scope, String code, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteJobValidateBeforeCall(scope, code, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getHistory
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start This field is obsolete, the value of this field would not be considered. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional)
* @param filter Expression to filter the result set. (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getHistoryCall(String page, List sortBy, Integer start, Integer limit, String filter, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/jobs/history";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (sortBy != null) {
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortBy", sortBy));
}
if (start != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("start", start));
}
if (limit != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit));
}
if (filter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter", filter));
}
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getHistoryValidateBeforeCall(String page, List sortBy, Integer start, Integer limit, String filter, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getHistoryCall(page, sortBy, start, limit, filter, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] GetHistory: Get the history of job runs
*
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start This field is obsolete, the value of this field would not be considered. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional)
* @param filter Expression to filter the result set. (optional)
* @return ResourceListOfJobHistory
* @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
The details of the input related failure
-
0
Error response
-
*/
public ResourceListOfJobHistory getHistory(String page, List sortBy, Integer start, Integer limit, String filter) throws ApiException {
ApiResponse localVarResp = getHistoryWithHttpInfo(page, sortBy, start, limit, filter);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] GetHistory: Get the history of job runs
*
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start This field is obsolete, the value of this field would not be considered. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional)
* @param filter Expression to filter the result set. (optional)
* @return ApiResponse<ResourceListOfJobHistory>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse getHistoryWithHttpInfo(String page, List sortBy, Integer start, Integer limit, String filter) throws ApiException {
okhttp3.Call localVarCall = getHistoryValidateBeforeCall(page, sortBy, start, limit, filter, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] GetHistory: Get the history of job runs (asynchronously)
*
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start This field is obsolete, the value of this field would not be considered. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional)
* @param filter Expression to filter the result set. (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getHistoryAsync(String page, List sortBy, Integer start, Integer limit, String filter, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getHistoryValidateBeforeCall(page, sortBy, start, limit, filter, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getJobConsoleOutput
* @param runId The RunId of the job run (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getJobConsoleOutputCall(String runId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/jobs/history/{runId}/console"
.replaceAll("\\{" + "runId" + "\\}", localVarApiClient.escapeString(runId.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"
};
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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getJobConsoleOutputValidateBeforeCall(String runId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'runId' is set
if (runId == null) {
throw new ApiException("Missing the required parameter 'runId' when calling getJobConsoleOutput(Async)");
}
okhttp3.Call localVarCall = getJobConsoleOutputCall(runId, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] GetJobConsoleOutput: Gets the console output of a specific job run
*
* @param runId The RunId of the job run (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
The details of the input related failure
-
0
Error response
-
*/
public String getJobConsoleOutput(String runId) throws ApiException {
ApiResponse localVarResp = getJobConsoleOutputWithHttpInfo(runId);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] GetJobConsoleOutput: Gets the console output of a specific job run
*
* @param runId The RunId of the job run (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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse getJobConsoleOutputWithHttpInfo(String runId) throws ApiException {
okhttp3.Call localVarCall = getJobConsoleOutputValidateBeforeCall(runId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] GetJobConsoleOutput: Gets the console output of a specific job run (asynchronously)
*
* @param runId The RunId of the job run (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getJobConsoleOutputAsync(String runId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getJobConsoleOutputValidateBeforeCall(runId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getRunHistory
* @param runId The unique ID of the run (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getRunHistoryCall(String runId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/jobs/history/{runId}"
.replaceAll("\\{" + "runId" + "\\}", localVarApiClient.escapeString(runId.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getRunHistoryValidateBeforeCall(String runId, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'runId' is set
if (runId == null) {
throw new ApiException("Missing the required parameter 'runId' when calling getRunHistory(Async)");
}
okhttp3.Call localVarCall = getRunHistoryCall(runId, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] GetRunHistory: Get the history for a single job run
*
* @param runId The unique ID of the run (required)
* @return JobRunResult
* @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
The details of the input related failure
-
0
Error response
-
*/
public JobRunResult getRunHistory(String runId) throws ApiException {
ApiResponse localVarResp = getRunHistoryWithHttpInfo(runId);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] GetRunHistory: Get the history for a single job run
*
* @param runId The unique ID of the run (required)
* @return ApiResponse<JobRunResult>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse getRunHistoryWithHttpInfo(String runId) throws ApiException {
okhttp3.Call localVarCall = getRunHistoryValidateBeforeCall(runId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] GetRunHistory: Get the history for a single job run (asynchronously)
*
* @param runId The unique ID of the run (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getRunHistoryAsync(String runId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getRunHistoryValidateBeforeCall(runId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getSchedulesForAJob
* @param scope The scope of the job (required)
* @param code The code of the job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getSchedulesForAJobCall(String scope, String code, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/jobs/{scope}/{code}/schedules"
.replaceAll("\\{" + "scope" + "\\}", localVarApiClient.escapeString(scope.toString()))
.replaceAll("\\{" + "code" + "\\}", localVarApiClient.escapeString(code.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getSchedulesForAJobValidateBeforeCall(String scope, String code, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'scope' is set
if (scope == null) {
throw new ApiException("Missing the required parameter 'scope' when calling getSchedulesForAJob(Async)");
}
// verify the required parameter 'code' is set
if (code == null) {
throw new ApiException("Missing the required parameter 'code' when calling getSchedulesForAJob(Async)");
}
okhttp3.Call localVarCall = getSchedulesForAJobCall(scope, code, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] GetSchedulesForAJob: Get all the schedules for a single job
*
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @return ResourceListOfScheduleDefinition
* @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
The details of the input related failure
-
0
Error response
-
*/
public ResourceListOfScheduleDefinition getSchedulesForAJob(String scope, String code) throws ApiException {
ApiResponse localVarResp = getSchedulesForAJobWithHttpInfo(scope, code);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] GetSchedulesForAJob: Get all the schedules for a single job
*
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @return ApiResponse<ResourceListOfScheduleDefinition>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse getSchedulesForAJobWithHttpInfo(String scope, String code) throws ApiException {
okhttp3.Call localVarCall = getSchedulesForAJobValidateBeforeCall(scope, code, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] GetSchedulesForAJob: Get all the schedules for a single job (asynchronously)
*
* @param scope The scope of the job (required)
* @param code The code of the job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call getSchedulesForAJobAsync(String scope, String code, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getSchedulesForAJobValidateBeforeCall(scope, code, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for listJobs
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start When paginating, skip this number of results. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional, default to 2000)
* @param filter Expression to filter the result set. (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call listJobsCall(String page, List sortBy, Integer start, Integer limit, String filter, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/api/jobs";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (page != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page", page));
}
if (sortBy != null) {
localVarCollectionQueryParams.addAll(localVarApiClient.parameterToPairs("multi", "sortBy", sortBy));
}
if (start != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("start", start));
}
if (limit != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("limit", limit));
}
if (filter != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter", filter));
}
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call listJobsValidateBeforeCall(String page, List sortBy, Integer start, Integer limit, String filter, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = listJobsCall(page, sortBy, start, limit, filter, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] ListJobs: List the available jobs
*
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start When paginating, skip this number of results. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional, default to 2000)
* @param filter Expression to filter the result set. (optional)
* @return ResourceListOfJobDefinition
* @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
The details of the input related failure
-
0
Error response
-
*/
public ResourceListOfJobDefinition listJobs(String page, List sortBy, Integer start, Integer limit, String filter) throws ApiException {
ApiResponse localVarResp = listJobsWithHttpInfo(page, sortBy, start, limit, filter);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] ListJobs: List the available jobs
*
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start When paginating, skip this number of results. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional, default to 2000)
* @param filter Expression to filter the result set. (optional)
* @return ApiResponse<ResourceListOfJobDefinition>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse listJobsWithHttpInfo(String page, List sortBy, Integer start, Integer limit, String filter) throws ApiException {
okhttp3.Call localVarCall = listJobsValidateBeforeCall(page, sortBy, start, limit, filter, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] ListJobs: List the available jobs (asynchronously)
*
* @param page The pagination token to use to continue listing instruments from a previous call to list instruments. This value is returned from the previous call. If a pagination token is provided the sortBy and filter fields must not have changed since the original request. Also, if set, a start value cannot be provided. (optional)
* @param sortBy Order the results by these fields. Use use the '-' sign to denote descending order e.g. -MyFieldName. (optional)
* @param start When paginating, skip this number of results. (optional)
* @param limit When paginating, limit the number of returned results to this many. Defaults to 2000 if not specified. Maximum is 5000. (optional, default to 2000)
* @param filter Expression to filter the result set. (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call listJobsAsync(String page, List sortBy, Integer start, Integer limit, String filter, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = listJobsValidateBeforeCall(page, sortBy, start, limit, filter, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for runJob
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @param startJobRequest The request for starting job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call runJobCall(String scope, String code, StartJobRequest startJobRequest, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = startJobRequest;
// create path and map variables
String localVarPath = "/api/jobs/{scope}/{code}/$run"
.replaceAll("\\{" + "scope" + "\\}", localVarApiClient.escapeString(scope.toString()))
.replaceAll("\\{" + "code" + "\\}", localVarApiClient.escapeString(code.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call runJobValidateBeforeCall(String scope, String code, StartJobRequest startJobRequest, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'scope' is set
if (scope == null) {
throw new ApiException("Missing the required parameter 'scope' when calling runJob(Async)");
}
// verify the required parameter 'code' is set
if (code == null) {
throw new ApiException("Missing the required parameter 'code' when calling runJob(Async)");
}
// verify the required parameter 'startJobRequest' is set
if (startJobRequest == null) {
throw new ApiException("Missing the required parameter 'startJobRequest' when calling runJob(Async)");
}
okhttp3.Call localVarCall = runJobCall(scope, code, startJobRequest, _callback);
return localVarCall;
}
/**
* RunJob: Run a job immediately
*
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @param startJobRequest The request for starting job (required)
* @return StartJobResponse
* @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
The details of the input related failure
-
0
Error response
-
*/
public StartJobResponse runJob(String scope, String code, StartJobRequest startJobRequest) throws ApiException {
ApiResponse localVarResp = runJobWithHttpInfo(scope, code, startJobRequest);
return localVarResp.getData();
}
/**
* RunJob: Run a job immediately
*
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @param startJobRequest The request for starting job (required)
* @return ApiResponse<StartJobResponse>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse runJobWithHttpInfo(String scope, String code, StartJobRequest startJobRequest) throws ApiException {
okhttp3.Call localVarCall = runJobValidateBeforeCall(scope, code, startJobRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* RunJob: Run a job immediately (asynchronously)
*
* @param scope The scope of the job (required)
* @param code The code of the job (required)
* @param startJobRequest The request for starting job (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call runJobAsync(String scope, String code, StartJobRequest startJobRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = runJobValidateBeforeCall(scope, code, startJobRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for updateJob
* @param scope (required)
* @param code (required)
* @param updateJobRequest (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call updateJobCall(String scope, String code, UpdateJobRequest updateJobRequest, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = updateJobRequest;
// create path and map variables
String localVarPath = "/api/jobs/{scope}/{code}"
.replaceAll("\\{" + "scope" + "\\}", localVarApiClient.escapeString(scope.toString()))
.replaceAll("\\{" + "code" + "\\}", localVarApiClient.escapeString(code.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/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", "0.0.936");
String[] localVarAuthNames = new String[] { "oauth2" };
return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateJobValidateBeforeCall(String scope, String code, UpdateJobRequest updateJobRequest, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'scope' is set
if (scope == null) {
throw new ApiException("Missing the required parameter 'scope' when calling updateJob(Async)");
}
// verify the required parameter 'code' is set
if (code == null) {
throw new ApiException("Missing the required parameter 'code' when calling updateJob(Async)");
}
// verify the required parameter 'updateJobRequest' is set
if (updateJobRequest == null) {
throw new ApiException("Missing the required parameter 'updateJobRequest' when calling updateJob(Async)");
}
okhttp3.Call localVarCall = updateJobCall(scope, code, updateJobRequest, _callback);
return localVarCall;
}
/**
* [EXPERIMENTAL] UpdateJob: Update a JobDefinition
*
* @param scope (required)
* @param code (required)
* @param updateJobRequest (required)
* @return JobDefinition
* @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
The details of the input related failure
-
0
Error response
-
*/
public JobDefinition updateJob(String scope, String code, UpdateJobRequest updateJobRequest) throws ApiException {
ApiResponse localVarResp = updateJobWithHttpInfo(scope, code, updateJobRequest);
return localVarResp.getData();
}
/**
* [EXPERIMENTAL] UpdateJob: Update a JobDefinition
*
* @param scope (required)
* @param code (required)
* @param updateJobRequest (required)
* @return ApiResponse<JobDefinition>
* @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
The details of the input related failure
-
0
Error response
-
*/
public ApiResponse updateJobWithHttpInfo(String scope, String code, UpdateJobRequest updateJobRequest) throws ApiException {
okhttp3.Call localVarCall = updateJobValidateBeforeCall(scope, code, updateJobRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* [EXPERIMENTAL] UpdateJob: Update a JobDefinition (asynchronously)
*
* @param scope (required)
* @param code (required)
* @param updateJobRequest (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
The details of the input related failure
-
0
Error response
-
*/
public okhttp3.Call updateJobAsync(String scope, String code, UpdateJobRequest updateJobRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateJobValidateBeforeCall(scope, code, updateJobRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
}
