com.dominodatalab.api.rest.ExecutionEventsApi Maven / Gradle / Ivy
/*
* Domino Data Lab API v4
* This API is going to provide access to all the Domino functions available in the user interface. To authenticate your requests, include your API Key (which you can find on your account page) with the header X-Domino-Api-Key.
*
* The version of the OpenAPI document: 4.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.api.rest;
import com.dominodatalab.api.invoker.ApiClient;
import com.dominodatalab.api.invoker.ApiException;
import com.dominodatalab.api.invoker.ApiResponse;
import com.dominodatalab.api.invoker.Pair;
import com.dominodatalab.api.model.DominoApiErrorResponse;
import com.dominodatalab.api.model.DominoComputegridExecutionEventDto;
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 = "2023-10-17T15:20:46.682098100-04:00[America/New_York]")
public class ExecutionEventsApi {
private final HttpClient memberVarHttpClient;
private final ObjectMapper memberVarObjectMapper;
private final String memberVarBaseUri;
private final Consumer memberVarInterceptor;
private final Duration memberVarReadTimeout;
private final Consumer> memberVarResponseInterceptor;
private final Consumer> memberVarAsyncResponseInterceptor;
public ExecutionEventsApi() {
this(new ApiClient());
}
public ExecutionEventsApi(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);
}
private String formatExceptionMessage(String operationId, int statusCode, String body) {
if (body == null || body.isEmpty()) {
body = "[no body]";
}
return operationId + " call failed with: " + statusCode + " - " + body;
}
/**
* Retrieves a list of execution events for a given execution id
*
* @param executionId Execution Id (required)
* @param pageSize Number of events to fetch (optional)
* @param pageNumber Page number to fetch (optional)
* @param sortOrder Sort order (1 for ascending, -1 for descending) (optional)
* @param sortBy Field to sort by (optional)
* @param fields (optional)
* @param excludeIgnoredEvents If true, do not return events with Ignored status (optional)
* @param excludeIgnoredHeartbeats If true, do not return heartbeats with Ignored status (optional)
* @param inline If true, open the execution event history JSON payload in the browser, else download a file called `domino_event_log_[execution id].json`. (optional, default to true)
* @return List<DominoComputegridExecutionEventDto>
* @throws ApiException if fails to make API call
*/
public List getExecutionEvents(String executionId, Integer pageSize, Integer pageNumber, Integer sortOrder, String sortBy, String fields, String excludeIgnoredEvents, String excludeIgnoredHeartbeats, String inline) throws ApiException {
ApiResponse> localVarResponse = getExecutionEventsWithHttpInfo(executionId, pageSize, pageNumber, sortOrder, sortBy, fields, excludeIgnoredEvents, excludeIgnoredHeartbeats, inline);
return localVarResponse.getData();
}
/**
* Retrieves a list of execution events for a given execution id
*
* @param executionId Execution Id (required)
* @param pageSize Number of events to fetch (optional)
* @param pageNumber Page number to fetch (optional)
* @param sortOrder Sort order (1 for ascending, -1 for descending) (optional)
* @param sortBy Field to sort by (optional)
* @param fields (optional)
* @param excludeIgnoredEvents If true, do not return events with Ignored status (optional)
* @param excludeIgnoredHeartbeats If true, do not return heartbeats with Ignored status (optional)
* @param inline If true, open the execution event history JSON payload in the browser, else download a file called `domino_event_log_[execution id].json`. (optional, default to true)
* @return ApiResponse<List<DominoComputegridExecutionEventDto>>
* @throws ApiException if fails to make API call
*/
public ApiResponse> getExecutionEventsWithHttpInfo(String executionId, Integer pageSize, Integer pageNumber, Integer sortOrder, String sortBy, String fields, String excludeIgnoredEvents, String excludeIgnoredHeartbeats, String inline) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = getExecutionEventsRequestBuilder(executionId, pageSize, pageNumber, sortOrder, sortBy, fields, excludeIgnoredEvents, excludeIgnoredHeartbeats, inline);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("getExecutionEvents", 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);
}
}
private HttpRequest.Builder getExecutionEventsRequestBuilder(String executionId, Integer pageSize, Integer pageNumber, Integer sortOrder, String sortBy, String fields, String excludeIgnoredEvents, String excludeIgnoredHeartbeats, String inline) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException(400, "Missing the required parameter 'executionId' when calling getExecutionEvents");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/executions/{executionId}/events"
.replace("{executionId}", ApiClient.urlEncode(executionId.toString()));
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "pageSize";
localVarQueryParams.addAll(ApiClient.parameterToPairs("pageSize", pageSize));
localVarQueryParameterBaseName = "pageNumber";
localVarQueryParams.addAll(ApiClient.parameterToPairs("pageNumber", pageNumber));
localVarQueryParameterBaseName = "sortOrder";
localVarQueryParams.addAll(ApiClient.parameterToPairs("sortOrder", sortOrder));
localVarQueryParameterBaseName = "sortBy";
localVarQueryParams.addAll(ApiClient.parameterToPairs("sortBy", sortBy));
localVarQueryParameterBaseName = "fields";
localVarQueryParams.addAll(ApiClient.parameterToPairs("fields", fields));
localVarQueryParameterBaseName = "excludeIgnoredEvents";
localVarQueryParams.addAll(ApiClient.parameterToPairs("excludeIgnoredEvents", excludeIgnoredEvents));
localVarQueryParameterBaseName = "excludeIgnoredHeartbeats";
localVarQueryParams.addAll(ApiClient.parameterToPairs("excludeIgnoredHeartbeats", excludeIgnoredHeartbeats));
localVarQueryParameterBaseName = "inline";
localVarQueryParams.addAll(ApiClient.parameterToPairs("inline", inline));
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;
}
/**
* Retrieves a list of execution events for a given execution id in csv format
*
* @param executionId Execution Id (required)
* @param pageSize Number of events to fetch (optional)
* @param pageNumber Page number to fetch (optional)
* @param sortOrder Sort order (1 for ascending, -1 for descending) (optional)
* @param sortBy Field to sort by (optional)
* @param fields (optional)
* @param excludeIgnoredEvents If true, do not return events with Ignored status (optional)
* @param excludeIgnoredHeartbeats If true, do not return heartbeats with Ignored status (optional)
* @param inline If true, open the file in the browser, else download a file called `domino_event_log_[execution id].csv`. (optional, default to true)
* @return String
* @throws ApiException if fails to make API call
*/
public String getExecutionEventsCsv(String executionId, Integer pageSize, Integer pageNumber, Integer sortOrder, String sortBy, String fields, String excludeIgnoredEvents, String excludeIgnoredHeartbeats, String inline) throws ApiException {
ApiResponse localVarResponse = getExecutionEventsCsvWithHttpInfo(executionId, pageSize, pageNumber, sortOrder, sortBy, fields, excludeIgnoredEvents, excludeIgnoredHeartbeats, inline);
return localVarResponse.getData();
}
/**
* Retrieves a list of execution events for a given execution id in csv format
*
* @param executionId Execution Id (required)
* @param pageSize Number of events to fetch (optional)
* @param pageNumber Page number to fetch (optional)
* @param sortOrder Sort order (1 for ascending, -1 for descending) (optional)
* @param sortBy Field to sort by (optional)
* @param fields (optional)
* @param excludeIgnoredEvents If true, do not return events with Ignored status (optional)
* @param excludeIgnoredHeartbeats If true, do not return heartbeats with Ignored status (optional)
* @param inline If true, open the file in the browser, else download a file called `domino_event_log_[execution id].csv`. (optional, default to true)
* @return ApiResponse<String>
* @throws ApiException if fails to make API call
*/
public ApiResponse getExecutionEventsCsvWithHttpInfo(String executionId, Integer pageSize, Integer pageNumber, Integer sortOrder, String sortBy, String fields, String excludeIgnoredEvents, String excludeIgnoredHeartbeats, String inline) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = getExecutionEventsCsvRequestBuilder(executionId, pageSize, pageNumber, sortOrder, sortBy, fields, excludeIgnoredEvents, excludeIgnoredHeartbeats, inline);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("getExecutionEventsCsv", 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);
}
}
private HttpRequest.Builder getExecutionEventsCsvRequestBuilder(String executionId, Integer pageSize, Integer pageNumber, Integer sortOrder, String sortBy, String fields, String excludeIgnoredEvents, String excludeIgnoredHeartbeats, String inline) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException(400, "Missing the required parameter 'executionId' when calling getExecutionEventsCsv");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/executions/{executionId}/events.csv"
.replace("{executionId}", ApiClient.urlEncode(executionId.toString()));
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "pageSize";
localVarQueryParams.addAll(ApiClient.parameterToPairs("pageSize", pageSize));
localVarQueryParameterBaseName = "pageNumber";
localVarQueryParams.addAll(ApiClient.parameterToPairs("pageNumber", pageNumber));
localVarQueryParameterBaseName = "sortOrder";
localVarQueryParams.addAll(ApiClient.parameterToPairs("sortOrder", sortOrder));
localVarQueryParameterBaseName = "sortBy";
localVarQueryParams.addAll(ApiClient.parameterToPairs("sortBy", sortBy));
localVarQueryParameterBaseName = "fields";
localVarQueryParams.addAll(ApiClient.parameterToPairs("fields", fields));
localVarQueryParameterBaseName = "excludeIgnoredEvents";
localVarQueryParams.addAll(ApiClient.parameterToPairs("excludeIgnoredEvents", excludeIgnoredEvents));
localVarQueryParameterBaseName = "excludeIgnoredHeartbeats";
localVarQueryParams.addAll(ApiClient.parameterToPairs("excludeIgnoredHeartbeats", excludeIgnoredHeartbeats));
localVarQueryParameterBaseName = "inline";
localVarQueryParams.addAll(ApiClient.parameterToPairs("inline", inline));
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;
}
/**
* Increments an execution counter event for a given execution id (creates if missing) by 1
*
* @param executionId Execution Id (required)
* @param metricName Metric name (required)
* @param epochMillisOrZero time in milliseconds from epoch (UNIX timestamp) or 0 to use server current time (optional, default to 0)
* @param count count to increase counter by (defaults to 1) (optional, default to 1)
* @throws ApiException if fails to make API call
*/
public void incrementExecutionCounter(String executionId, String metricName, Long epochMillisOrZero, Integer count) throws ApiException {
incrementExecutionCounterWithHttpInfo(executionId, metricName, epochMillisOrZero, count);
}
/**
* Increments an execution counter event for a given execution id (creates if missing) by 1
*
* @param executionId Execution Id (required)
* @param metricName Metric name (required)
* @param epochMillisOrZero time in milliseconds from epoch (UNIX timestamp) or 0 to use server current time (optional, default to 0)
* @param count count to increase counter by (defaults to 1) (optional, default to 1)
* @return ApiResponse<Void>
* @throws ApiException if fails to make API call
*/
public ApiResponse incrementExecutionCounterWithHttpInfo(String executionId, String metricName, Long epochMillisOrZero, Integer count) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = incrementExecutionCounterRequestBuilder(executionId, metricName, epochMillisOrZero, count);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("incrementExecutionCounter", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
null
);
} finally {
// Drain the InputStream
while (localVarResponse.body().read() != -1) {
// Ignore
}
localVarResponse.body().close();
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
private HttpRequest.Builder incrementExecutionCounterRequestBuilder(String executionId, String metricName, Long epochMillisOrZero, Integer count) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException(400, "Missing the required parameter 'executionId' when calling incrementExecutionCounter");
}
// verify the required parameter 'metricName' is set
if (metricName == null) {
throw new ApiException(400, "Missing the required parameter 'metricName' when calling incrementExecutionCounter");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/executions/{executionId}/metrics/{metricName}/increment"
.replace("{executionId}", ApiClient.urlEncode(executionId.toString()))
.replace("{metricName}", ApiClient.urlEncode(metricName.toString()));
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "epochMillisOrZero";
localVarQueryParams.addAll(ApiClient.parameterToPairs("epochMillisOrZero", epochMillisOrZero));
localVarQueryParameterBaseName = "count";
localVarQueryParams.addAll(ApiClient.parameterToPairs("count", count));
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("POST", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
/**
* Starts (or ends) an execution trace event for a given execution id
*
* @param executionId Execution Id (required)
* @param metricName Metric name (required)
* @param epochMillisOrZero time in milliseconds from epoch (UNIX timestamp) or 0 to use server current time (optional, default to 0)
* @throws ApiException if fails to make API call
*/
public void traceExecution(String executionId, String metricName, Long epochMillisOrZero) throws ApiException {
traceExecutionWithHttpInfo(executionId, metricName, epochMillisOrZero);
}
/**
* Starts (or ends) an execution trace event for a given execution id
*
* @param executionId Execution Id (required)
* @param metricName Metric name (required)
* @param epochMillisOrZero time in milliseconds from epoch (UNIX timestamp) or 0 to use server current time (optional, default to 0)
* @return ApiResponse<Void>
* @throws ApiException if fails to make API call
*/
public ApiResponse traceExecutionWithHttpInfo(String executionId, String metricName, Long epochMillisOrZero) throws ApiException {
HttpRequest.Builder localVarRequestBuilder = traceExecutionRequestBuilder(executionId, metricName, epochMillisOrZero);
try {
HttpResponse localVarResponse = memberVarHttpClient.send(
localVarRequestBuilder.build(),
HttpResponse.BodyHandlers.ofInputStream());
if (memberVarResponseInterceptor != null) {
memberVarResponseInterceptor.accept(localVarResponse);
}
try {
if (localVarResponse.statusCode()/ 100 != 2) {
throw getApiException("traceExecution", localVarResponse);
}
return new ApiResponse(
localVarResponse.statusCode(),
localVarResponse.headers().map(),
null
);
} finally {
// Drain the InputStream
while (localVarResponse.body().read() != -1) {
// Ignore
}
localVarResponse.body().close();
}
} catch (IOException e) {
throw new ApiException(e);
}
catch (InterruptedException e) {
Thread.currentThread().interrupt();
throw new ApiException(e);
}
}
private HttpRequest.Builder traceExecutionRequestBuilder(String executionId, String metricName, Long epochMillisOrZero) throws ApiException {
// verify the required parameter 'executionId' is set
if (executionId == null) {
throw new ApiException(400, "Missing the required parameter 'executionId' when calling traceExecution");
}
// verify the required parameter 'metricName' is set
if (metricName == null) {
throw new ApiException(400, "Missing the required parameter 'metricName' when calling traceExecution");
}
HttpRequest.Builder localVarRequestBuilder = HttpRequest.newBuilder();
String localVarPath = "/executions/{executionId}/metrics/{metricName}/trace"
.replace("{executionId}", ApiClient.urlEncode(executionId.toString()))
.replace("{metricName}", ApiClient.urlEncode(metricName.toString()));
List localVarQueryParams = new ArrayList<>();
StringJoiner localVarQueryStringJoiner = new StringJoiner("&");
String localVarQueryParameterBaseName;
localVarQueryParameterBaseName = "epochMillisOrZero";
localVarQueryParams.addAll(ApiClient.parameterToPairs("epochMillisOrZero", epochMillisOrZero));
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("POST", HttpRequest.BodyPublishers.noBody());
if (memberVarReadTimeout != null) {
localVarRequestBuilder.timeout(memberVarReadTimeout);
}
if (memberVarInterceptor != null) {
memberVarInterceptor.accept(localVarRequestBuilder);
}
return localVarRequestBuilder;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy