com.dominodatalab.pub.rest.JobsApi Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-java-client Show documentation
Show all versions of domino-java-client Show documentation
Domino Data Lab API Client to connect to Domino web services using Java HTTP Client.
/*
* Domino Public API
* Domino Public API Endpoints
*
* The version of the OpenAPI document: 0.0.0
*
*
* 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.dominodatalab.pub.rest;
import com.dominodatalab.pub.invoker.ApiClient;
import com.dominodatalab.pub.invoker.ApiException;
import com.dominodatalab.pub.invoker.ApiResponse;
import com.dominodatalab.pub.invoker.Pair;
import com.dominodatalab.pub.model.DeleteEnvelopeV1;
import com.dominodatalab.pub.model.FailureEnvelopeV1;
import com.dominodatalab.pub.model.GetAIGatewayAuditData400Response;
import com.dominodatalab.pub.model.GoalEnvelopeV1;
import com.dominodatalab.pub.model.GoalToLinkV1;
import com.dominodatalab.pub.model.JobEnvelopeV1;
import com.dominodatalab.pub.model.LogsEnvelopeV1;
import com.dominodatalab.pub.model.NewJobV1;
import com.dominodatalab.pub.model.PaginatedGoalEnvelopeV1;
import com.dominodatalab.pub.model.PaginatedJobEnvelopeV1;
import com.dominodatalab.pub.model.TagEnvelopeV1;
import com.dominodatalab.pub.model.TagToAddV1;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.InputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.net.http.HttpRequest;
import java.nio.channels.Channels;
import java.nio.channels.Pipe;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
import java.util.ArrayList;
import java.util.StringJoiner;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-10-04T16:37:28.765500600-04:00[America/New_York]", comments = "Generator version: 7.8.0")
public class JobsApi {
protected final HttpClient memberVarHttpClient;
protected final ObjectMapper memberVarObjectMapper;
protected final String memberVarBaseUri;
protected final Consumer memberVarInterceptor;
protected final Duration memberVarReadTimeout;
protected final Consumer> memberVarResponseInterceptor;
protected final Consumer> memberVarAsyncResponseInterceptor;
public JobsApi() {
this(new ApiClient());
}
public JobsApi(ApiClient apiClient) {
memberVarHttpClient = apiClient.getHttpClient();
memberVarObjectMapper = apiClient.getObjectMapper();
memberVarBaseUri = apiClient.getBaseUri();
memberVarInterceptor = apiClient.getRequestInterceptor();
memberVarReadTimeout = apiClient.getReadTimeout();
memberVarResponseInterceptor = apiClient.getResponseInterceptor();
memberVarAsyncResponseInterceptor = apiClient.getAsyncResponseInterceptor();
}
protected ApiException getApiException(String operationId, HttpResponse response) throws IOException {
String body = response.body() == null ? null : new String(response.body().readAllBytes());
String message = formatExceptionMessage(operationId, response.statusCode(), body);
return new ApiException(response.statusCode(), message, response.headers(), body);
}
protected String formatExceptionMessage(String operationId, int statusCode, String body) {
if (body == null || body.isEmpty()) {
body = "[no body]";
}
return operationId + " call failed with: " + statusCode + " - " + body;
}
/**
* Add a tag to a Job
* Add a Tag to the Job with the specified Id. Required permissions: `ViewJobs`
* @param jobId Id of job to add tag to (required)
* @param tagToAddV1 (required)
* @return TagEnvelopeV1
* @throws ApiException if fails to make API call
*/
public TagEnvelopeV1 addJobTag(String jobId, TagToAddV1 tagToAddV1) throws ApiException {
ApiResponse localVarResponse = addJobTagWithHttpInfo(jobId, tagToAddV1);
return localVarResponse.getData();
}
/**
* Add a tag to a Job
* Add a Tag to the Job with the specified Id. Required permissions: `ViewJobs`
* @param jobId Id of job to add tag to (required)
* @param tagToAddV1 (required)
* @return ApiResponse<TagEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse addJobTagWithHttpInfo(String jobId, TagToAddV1 tagToAddV1) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = addJobTagRequestBuilder(jobId, tagToAddV1);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("addJobTag", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder addJobTagRequestBuilder(String jobId, TagToAddV1 tagToAddV1) throws ApiException {
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException(400, "Missing the required parameter 'jobId' when calling addJobTag");
}
// verify the required parameter 'tagToAddV1' is set
if (tagToAddV1 == null) {
throw new ApiException(400, "Missing the required parameter 'tagToAddV1' when calling addJobTag");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/v1/jobs/{jobId}/tags"
.replace("{jobId}", ApiClient.urlEncode(jobId.toString()));
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
localVarRequestBuilder.header("Content-Type", "application/json");
localVarRequestBuilder.header("Accept", "application/json");
try {
byte[] localVarPostBody = memberVarObjectMapper.writeValueAsBytes(tagToAddV1);
localVarRequestBuilder.method("POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody));
} catch (IOException e) {
throw new ApiException(e);
}
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Get Job details
* Retrieve a Job's details by its Id. Required permissions: `ViewJobs`. *Note:* This is a beta endpoint with known limitations.
* @param jobId Id of Job to retrieve details for (required)
* @return JobEnvelopeV1
* @throws ApiException if fails to make API call
*/
public JobEnvelopeV1 getJobDetails(String jobId) throws ApiException {
ApiResponse localVarResponse = getJobDetailsWithHttpInfo(jobId);
return localVarResponse.getData();
}
/**
* Get Job details
* Retrieve a Job's details by its Id. Required permissions: `ViewJobs`. *Note:* This is a beta endpoint with known limitations.
* @param jobId Id of Job to retrieve details for (required)
* @return ApiResponse<JobEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse getJobDetailsWithHttpInfo(String jobId) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = getJobDetailsRequestBuilder(jobId);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("getJobDetails", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder getJobDetailsRequestBuilder(String jobId) throws ApiException {
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException(400, "Missing the required parameter 'jobId' when calling getJobDetails");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/beta/jobs/{jobId}"
.replace("{jobId}", ApiClient.urlEncode(jobId.toString()));
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
localVarRequestBuilder.header("Accept", "application/json");
localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Get logs for a Job
* Retrieve the logs for the Job with the specified Id. Required permissions: `ViewJobs`. *Note:* This is a beta endpoint with known limitations.
* @param jobId Id of job to get logs for (required)
* @param logType Type of log to retrieve. Case insensitive. (optional)
* @param limit Max number of log lines to fetch. Will not retrieve over 10000 log lines at a time. (optional)
* @param latestTimeNano The epoch time in nanoseconds to start fetching from (optional)
* @return LogsEnvelopeV1
* @throws ApiException if fails to make API call
*/
public LogsEnvelopeV1 getJobLogs(String jobId, String logType, Integer limit, String latestTimeNano) throws ApiException {
ApiResponse localVarResponse = getJobLogsWithHttpInfo(jobId, logType, limit, latestTimeNano);
return localVarResponse.getData();
}
/**
* Get logs for a Job
* Retrieve the logs for the Job with the specified Id. Required permissions: `ViewJobs`. *Note:* This is a beta endpoint with known limitations.
* @param jobId Id of job to get logs for (required)
* @param logType Type of log to retrieve. Case insensitive. (optional)
* @param limit Max number of log lines to fetch. Will not retrieve over 10000 log lines at a time. (optional)
* @param latestTimeNano The epoch time in nanoseconds to start fetching from (optional)
* @return ApiResponse<LogsEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse getJobLogsWithHttpInfo(String jobId, String logType, Integer limit, String latestTimeNano) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = getJobLogsRequestBuilder(jobId, logType, limit, latestTimeNano);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("getJobLogs", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder getJobLogsRequestBuilder(String jobId, String logType, Integer limit, String latestTimeNano) throws ApiException {
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException(400, "Missing the required parameter 'jobId' when calling getJobLogs");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/beta/jobs/{jobId}/logs"
.replace("{jobId}", ApiClient.urlEncode(jobId.toString()));
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "logType";
localVarQueryParams.addAll(ApiClient.parameterToPairs("logType", logType));
localVarQueryParameterBaseName = "limit";
localVarQueryParams.addAll(ApiClient.parameterToPairs("limit", limit));
localVarQueryParameterBaseName = "latestTimeNano";
localVarQueryParams.addAll(ApiClient.parameterToPairs("latestTimeNano", latestTimeNano));
if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) {
StringJoiner queryJoiner = new StringJoiner("&");
localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue()));
if (localVarQueryStringJoiner.length() != 0) {
queryJoiner.add(localVarQueryStringJoiner.toString());
}
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString()));
} else {
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
}
localVarRequestBuilder.header("Accept", "application/json");
localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Get Jobs for a project
* Retrieve all Jobs that belong to a project. Required permissions: `ViewJobs.` *Note:* This is a beta endpoint with known limitations.
* @param projectId Id of project to retrieve Jobs for (required)
* @param offset Number of jobs from the start to skip. Defaults to 0. (optional)
* @param limit Total number of Jobs to retrieve. Defaults to 10. (optional)
* @param sortBy Field to sort Jobs by. Defaults to \"number\". (optional)
* @param dominoStatsSortFieldName Field in domino stats to sort by. Only used if sortBy = dominoStatsField. (optional)
* @param ascending Whether to sort ascending or descending. Defaults to to False. (optional)
* @param showArchived Whether to include archived Jobs in results. Defaults to false. (optional)
* @param statusFilter Status of Jobs to fetch. Defaults to \"all\". (optional)
* @param tagFilter Tag to filter by. Must match tag name exactly. (optional)
* @return PaginatedJobEnvelopeV1
* @throws ApiException if fails to make API call
*/
public PaginatedJobEnvelopeV1 getJobs(String projectId, Integer offset, Integer limit, String sortBy, String dominoStatsSortFieldName, Boolean ascending, Boolean showArchived, String statusFilter, String tagFilter) throws ApiException {
ApiResponse localVarResponse = getJobsWithHttpInfo(projectId, offset, limit, sortBy, dominoStatsSortFieldName, ascending, showArchived, statusFilter, tagFilter);
return localVarResponse.getData();
}
/**
* Get Jobs for a project
* Retrieve all Jobs that belong to a project. Required permissions: `ViewJobs.` *Note:* This is a beta endpoint with known limitations.
* @param projectId Id of project to retrieve Jobs for (required)
* @param offset Number of jobs from the start to skip. Defaults to 0. (optional)
* @param limit Total number of Jobs to retrieve. Defaults to 10. (optional)
* @param sortBy Field to sort Jobs by. Defaults to \"number\". (optional)
* @param dominoStatsSortFieldName Field in domino stats to sort by. Only used if sortBy = dominoStatsField. (optional)
* @param ascending Whether to sort ascending or descending. Defaults to to False. (optional)
* @param showArchived Whether to include archived Jobs in results. Defaults to false. (optional)
* @param statusFilter Status of Jobs to fetch. Defaults to \"all\". (optional)
* @param tagFilter Tag to filter by. Must match tag name exactly. (optional)
* @return ApiResponse<PaginatedJobEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse getJobsWithHttpInfo(String projectId, Integer offset, Integer limit, String sortBy, String dominoStatsSortFieldName, Boolean ascending, Boolean showArchived, String statusFilter, String tagFilter) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = getJobsRequestBuilder(projectId, offset, limit, sortBy, dominoStatsSortFieldName, ascending, showArchived, statusFilter, tagFilter);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("getJobs", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder getJobsRequestBuilder(String projectId, Integer offset, Integer limit, String sortBy, String dominoStatsSortFieldName, Boolean ascending, Boolean showArchived, String statusFilter, String tagFilter) throws ApiException {
// verify the required parameter 'projectId' is set
if (projectId == null) {
throw new ApiException(400, "Missing the required parameter 'projectId' when calling getJobs");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/beta/jobs";
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "projectId";
localVarQueryParams.addAll(ApiClient.parameterToPairs("projectId", projectId));
localVarQueryParameterBaseName = "offset";
localVarQueryParams.addAll(ApiClient.parameterToPairs("offset", offset));
localVarQueryParameterBaseName = "limit";
localVarQueryParams.addAll(ApiClient.parameterToPairs("limit", limit));
localVarQueryParameterBaseName = "sortBy";
localVarQueryParams.addAll(ApiClient.parameterToPairs("sortBy", sortBy));
localVarQueryParameterBaseName = "dominoStatsSortFieldName";
localVarQueryParams.addAll(ApiClient.parameterToPairs("dominoStatsSortFieldName", dominoStatsSortFieldName));
localVarQueryParameterBaseName = "ascending";
localVarQueryParams.addAll(ApiClient.parameterToPairs("ascending", ascending));
localVarQueryParameterBaseName = "showArchived";
localVarQueryParams.addAll(ApiClient.parameterToPairs("showArchived", showArchived));
localVarQueryParameterBaseName = "statusFilter";
localVarQueryParams.addAll(ApiClient.parameterToPairs("statusFilter", statusFilter));
localVarQueryParameterBaseName = "tagFilter";
localVarQueryParams.addAll(ApiClient.parameterToPairs("tagFilter", tagFilter));
if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) {
StringJoiner queryJoiner = new StringJoiner("&");
localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue()));
if (localVarQueryStringJoiner.length() != 0) {
queryJoiner.add(localVarQueryStringJoiner.toString());
}
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString()));
} else {
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
}
localVarRequestBuilder.header("Accept", "application/json");
localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Get linked goals for a job
* Retrieve goals for a Job with the specified Id. Required permissions: `ViewJobs`
* @param jobId Id of job to link to goal (required)
* @return PaginatedGoalEnvelopeV1
* @throws ApiException if fails to make API call
*/
public PaginatedGoalEnvelopeV1 getLinkedGoalsForJob(String jobId) throws ApiException {
ApiResponse localVarResponse = getLinkedGoalsForJobWithHttpInfo(jobId);
return localVarResponse.getData();
}
/**
* Get linked goals for a job
* Retrieve goals for a Job with the specified Id. Required permissions: `ViewJobs`
* @param jobId Id of job to link to goal (required)
* @return ApiResponse<PaginatedGoalEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse getLinkedGoalsForJobWithHttpInfo(String jobId) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = getLinkedGoalsForJobRequestBuilder(jobId);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("getLinkedGoalsForJob", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder getLinkedGoalsForJobRequestBuilder(String jobId) throws ApiException {
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException(400, "Missing the required parameter 'jobId' when calling getLinkedGoalsForJob");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/v1/goals";
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "jobId";
localVarQueryParams.addAll(ApiClient.parameterToPairs("jobId", jobId));
if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) {
StringJoiner queryJoiner = new StringJoiner("&");
localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue()));
if (localVarQueryStringJoiner.length() != 0) {
queryJoiner.add(localVarQueryStringJoiner.toString());
}
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString()));
} else {
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
}
localVarRequestBuilder.header("Accept", "application/json");
localVarRequestBuilder.method("GET", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Link a goal to a job
* Link the Goal with the specified Id to a Job. Required permissions: `ViewJobs, Edit`
* @param jobId Id of job to link to goal (required)
* @param goalToLinkV1 (required)
* @return GoalEnvelopeV1
* @throws ApiException if fails to make API call
*/
public GoalEnvelopeV1 linkJobToGoal(String jobId, GoalToLinkV1 goalToLinkV1) throws ApiException {
ApiResponse localVarResponse = linkJobToGoalWithHttpInfo(jobId, goalToLinkV1);
return localVarResponse.getData();
}
/**
* Link a goal to a job
* Link the Goal with the specified Id to a Job. Required permissions: `ViewJobs, Edit`
* @param jobId Id of job to link to goal (required)
* @param goalToLinkV1 (required)
* @return ApiResponse<GoalEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse linkJobToGoalWithHttpInfo(String jobId, GoalToLinkV1 goalToLinkV1) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = linkJobToGoalRequestBuilder(jobId, goalToLinkV1);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("linkJobToGoal", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder linkJobToGoalRequestBuilder(String jobId, GoalToLinkV1 goalToLinkV1) throws ApiException {
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException(400, "Missing the required parameter 'jobId' when calling linkJobToGoal");
}
// verify the required parameter 'goalToLinkV1' is set
if (goalToLinkV1 == null) {
throw new ApiException(400, "Missing the required parameter 'goalToLinkV1' when calling linkJobToGoal");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/v1/goals";
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "jobId";
localVarQueryParams.addAll(ApiClient.parameterToPairs("jobId", jobId));
if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) {
StringJoiner queryJoiner = new StringJoiner("&");
localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue()));
if (localVarQueryStringJoiner.length() != 0) {
queryJoiner.add(localVarQueryStringJoiner.toString());
}
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString()));
} else {
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
}
localVarRequestBuilder.header("Content-Type", "application/json");
localVarRequestBuilder.header("Accept", "application/json");
try {
byte[] localVarPostBody = memberVarObjectMapper.writeValueAsBytes(goalToLinkV1);
localVarRequestBuilder.method("POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody));
} catch (IOException e) {
throw new ApiException(e);
}
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Remove a tag from a Job
* Remove a Tag from the Job with the specified Id. Required permissions: `ViewJobs`
* @param jobId Id of job to remove tag from (required)
* @param tagId Id of tag to remove (required)
* @param projectId Id of project that tag belongs to (required)
* @return DeleteEnvelopeV1
* @throws ApiException if fails to make API call
*/
public DeleteEnvelopeV1 removeJobTag(String jobId, String tagId, String projectId) throws ApiException {
ApiResponse localVarResponse = removeJobTagWithHttpInfo(jobId, tagId, projectId);
return localVarResponse.getData();
}
/**
* Remove a tag from a Job
* Remove a Tag from the Job with the specified Id. Required permissions: `ViewJobs`
* @param jobId Id of job to remove tag from (required)
* @param tagId Id of tag to remove (required)
* @param projectId Id of project that tag belongs to (required)
* @return ApiResponse<DeleteEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse removeJobTagWithHttpInfo(String jobId, String tagId, String projectId) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = removeJobTagRequestBuilder(jobId, tagId, projectId);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("removeJobTag", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder removeJobTagRequestBuilder(String jobId, String tagId, String projectId) throws ApiException {
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException(400, "Missing the required parameter 'jobId' when calling removeJobTag");
}
// verify the required parameter 'tagId' is set
if (tagId == null) {
throw new ApiException(400, "Missing the required parameter 'tagId' when calling removeJobTag");
}
// verify the required parameter 'projectId' is set
if (projectId == null) {
throw new ApiException(400, "Missing the required parameter 'projectId' when calling removeJobTag");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/v1/jobs/{jobId}/tags/{tagId}"
.replace("{jobId}", ApiClient.urlEncode(jobId.toString()))
.replace("{tagId}", ApiClient.urlEncode(tagId.toString()));
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "projectId";
localVarQueryParams.addAll(ApiClient.parameterToPairs("projectId", projectId));
if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) {
StringJoiner queryJoiner = new StringJoiner("&");
localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue()));
if (localVarQueryStringJoiner.length() != 0) {
queryJoiner.add(localVarQueryStringJoiner.toString());
}
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString()));
} else {
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
}
localVarRequestBuilder.header("Accept", "application/json");
localVarRequestBuilder.method("DELETE", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Start a Job
* Start a new Job. Required permissions: `StartJob, UseGlobalCompute`
* @param newJobV1 (required)
* @return JobEnvelopeV1
* @throws ApiException if fails to make API call
*/
public JobEnvelopeV1 startJob(NewJobV1 newJobV1) throws ApiException {
ApiResponse localVarResponse = startJobWithHttpInfo(newJobV1);
return localVarResponse.getData();
}
/**
* Start a Job
* Start a new Job. Required permissions: `StartJob, UseGlobalCompute`
* @param newJobV1 (required)
* @return ApiResponse<JobEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse startJobWithHttpInfo(NewJobV1 newJobV1) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = startJobRequestBuilder(newJobV1);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("startJob", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder startJobRequestBuilder(NewJobV1 newJobV1) throws ApiException {
// verify the required parameter 'newJobV1' is set
if (newJobV1 == null) {
throw new ApiException(400, "Missing the required parameter 'newJobV1' when calling startJob");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/v1/jobs";
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
localVarRequestBuilder.header("Content-Type", "application/json");
localVarRequestBuilder.header("Accept", "application/json");
try {
byte[] localVarPostBody = memberVarObjectMapper.writeValueAsBytes(newJobV1);
localVarRequestBuilder.method("POST", HttpRequest.BodyPublishers.ofByteArray(localVarPostBody));
} catch (IOException e) {
throw new ApiException(e);
}
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Unlink goal from job
* Unlink the Goal with the specified Id from a Job. Required permissions: `ViewJobs, Edit`
* @param goalId Id of goal to remove (required)
* @param jobId Id of job to remove goal from (required)
* @return DeleteEnvelopeV1
* @throws ApiException if fails to make API call
*/
public DeleteEnvelopeV1 unlinkJobFromGoal(String goalId, String jobId) throws ApiException {
ApiResponse localVarResponse = unlinkJobFromGoalWithHttpInfo(goalId, jobId);
return localVarResponse.getData();
}
/**
* Unlink goal from job
* Unlink the Goal with the specified Id from a Job. Required permissions: `ViewJobs, Edit`
* @param goalId Id of goal to remove (required)
* @param jobId Id of job to remove goal from (required)
* @return ApiResponse<DeleteEnvelopeV1>
* @throws ApiException if fails to make API call
*/
public ApiResponse unlinkJobFromGoalWithHttpInfo(String goalId, String jobId) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = unlinkJobFromGoalRequestBuilder(goalId, jobId);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("unlinkJobFromGoal", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference() {}) // closes the InputStream
);
} finally {
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
protected HttpRequest.Builder unlinkJobFromGoalRequestBuilder(String goalId, String jobId) throws ApiException {
// verify the required parameter 'goalId' is set
if (goalId == null) {
throw new ApiException(400, "Missing the required parameter 'goalId' when calling unlinkJobFromGoal");
}
// verify the required parameter 'jobId' is set
if (jobId == null) {
throw new ApiException(400, "Missing the required parameter 'jobId' when calling unlinkJobFromGoal");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/api/jobs/v1/goals/{goalId}"
.replace("{goalId}", ApiClient.urlEncode(goalId.toString()));
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "jobId";
localVarQueryParams.addAll(ApiClient.parameterToPairs("jobId", jobId));
if (!localVarQueryParams.isEmpty() || localVarQueryStringJoiner.length() != 0) {
StringJoiner queryJoiner = new StringJoiner("&");
localVarQueryParams.forEach(p -> queryJoiner.add(p.getName() + '=' + p.getValue()));
if (localVarQueryStringJoiner.length() != 0) {
queryJoiner.add(localVarQueryStringJoiner.toString());
}
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath + '?' + queryJoiner.toString()));
} else {
localVarRequestBuilder.uri(URI.create(memberVarBaseUri + localVarPath));
}
localVarRequestBuilder.header("Accept", "application/json");
localVarRequestBuilder.method("DELETE", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy