org.openmetadata.client.api.TestCaseIncidentManagerApi Maven / Gradle / Ivy
package org.openmetadata.client.api;
import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;
import java.math.BigDecimal;
import org.openmetadata.client.model.CreateTestCaseResolutionStatus;
import org.openmetadata.client.model.TestCaseResolutionStatus;
import org.openmetadata.client.model.TestCaseResolutionStatusResultList;
import java.util.UUID;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-03T19:44:33.436780642Z[Etc/UTC]")
public interface TestCaseIncidentManagerApi extends ApiClient.Api {
/**
* Create a new test case failure status
* Create a new test case failure status
* @param createTestCaseResolutionStatus (optional)
* @return CreateTestCaseResolutionStatus
*/
@RequestLine("POST /v1/dataQuality/testCases/testCaseIncidentStatus")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
CreateTestCaseResolutionStatus createTestCaseResolutionStatus(CreateTestCaseResolutionStatus createTestCaseResolutionStatus);
/**
* Create a new test case failure status
* Similar to createTestCaseResolutionStatus but it also returns the http response headers .
* Create a new test case failure status
* @param createTestCaseResolutionStatus (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/dataQuality/testCases/testCaseIncidentStatus")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createTestCaseResolutionStatusWithHttpInfo(CreateTestCaseResolutionStatus createTestCaseResolutionStatus);
/**
* List the test case failure statuses
* Get a list of all the test case failure statuses, optionally filtered by `startTs` and `endTs` of the status creation, status, assignee, and test case id. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param testCaseId Test Case ID (optional)
* @param limit Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param offset Returns list of tests at the offset (optional)
* @param startTs Filter test case statuses after the given start timestamp (optional)
* @param endTs Filter test case statuses before the given end timestamp (optional)
* @param testCaseResolutionStatusType Filter test case statuses by status (optional)
* @param latest Only list the latest statuses (optional, default to false)
* @param assignee Filter test case statuses by assignee (optional)
* @param testCaseFQN Test case fully qualified name (optional)
* @return TestCaseResolutionStatusResultList
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus?testCaseId={testCaseId}&limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&testCaseResolutionStatusType={testCaseResolutionStatusType}&latest={latest}&assignee={assignee}&testCaseFQN={testCaseFQN}")
@Headers({
"Accept: application/json",
})
TestCaseResolutionStatusResultList getTestCaseResolutionStatus(@Param("testCaseId") UUID testCaseId, @Param("limit") Integer limit, @Param("offset") String offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs, @Param("testCaseResolutionStatusType") String testCaseResolutionStatusType, @Param("latest") Boolean latest, @Param("assignee") String assignee, @Param("testCaseFQN") String testCaseFQN);
/**
* List the test case failure statuses
* Similar to getTestCaseResolutionStatus but it also returns the http response headers .
* Get a list of all the test case failure statuses, optionally filtered by `startTs` and `endTs` of the status creation, status, assignee, and test case id. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param testCaseId Test Case ID (optional)
* @param limit Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param offset Returns list of tests at the offset (optional)
* @param startTs Filter test case statuses after the given start timestamp (optional)
* @param endTs Filter test case statuses before the given end timestamp (optional)
* @param testCaseResolutionStatusType Filter test case statuses by status (optional)
* @param latest Only list the latest statuses (optional, default to false)
* @param assignee Filter test case statuses by assignee (optional)
* @param testCaseFQN Test case fully qualified name (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus?testCaseId={testCaseId}&limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&testCaseResolutionStatusType={testCaseResolutionStatusType}&latest={latest}&assignee={assignee}&testCaseFQN={testCaseFQN}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestCaseResolutionStatusWithHttpInfo(@Param("testCaseId") UUID testCaseId, @Param("limit") Integer limit, @Param("offset") String offset, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs, @Param("testCaseResolutionStatusType") String testCaseResolutionStatusType, @Param("latest") Boolean latest, @Param("assignee") String assignee, @Param("testCaseFQN") String testCaseFQN);
/**
* List the test case failure statuses
* Get a list of all the test case failure statuses, optionally filtered by `startTs` and `endTs` of the status creation, status, assignee, and test case id. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other getTestCaseResolutionStatus method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetTestCaseResolutionStatusQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - testCaseId - Test Case ID (optional)
* - limit - Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* - offset - Returns list of tests at the offset (optional)
* - startTs - Filter test case statuses after the given start timestamp (optional)
* - endTs - Filter test case statuses before the given end timestamp (optional)
* - testCaseResolutionStatusType - Filter test case statuses by status (optional)
* - latest - Only list the latest statuses (optional, default to false)
* - assignee - Filter test case statuses by assignee (optional)
* - testCaseFQN - Test case fully qualified name (optional)
*
* @return TestCaseResolutionStatusResultList
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus?testCaseId={testCaseId}&limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&testCaseResolutionStatusType={testCaseResolutionStatusType}&latest={latest}&assignee={assignee}&testCaseFQN={testCaseFQN}")
@Headers({
"Accept: application/json",
})
TestCaseResolutionStatusResultList getTestCaseResolutionStatus(@QueryMap(encoded=true) GetTestCaseResolutionStatusQueryParams queryParams);
/**
* List the test case failure statuses
* Get a list of all the test case failure statuses, optionally filtered by `startTs` and `endTs` of the status creation, status, assignee, and test case id. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other getTestCaseResolutionStatus that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - testCaseId - Test Case ID (optional)
* - limit - Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* - offset - Returns list of tests at the offset (optional)
* - startTs - Filter test case statuses after the given start timestamp (optional)
* - endTs - Filter test case statuses before the given end timestamp (optional)
* - testCaseResolutionStatusType - Filter test case statuses by status (optional)
* - latest - Only list the latest statuses (optional, default to false)
* - assignee - Filter test case statuses by assignee (optional)
* - testCaseFQN - Test case fully qualified name (optional)
*
* @return TestCaseResolutionStatusResultList
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus?testCaseId={testCaseId}&limit={limit}&offset={offset}&startTs={startTs}&endTs={endTs}&testCaseResolutionStatusType={testCaseResolutionStatusType}&latest={latest}&assignee={assignee}&testCaseFQN={testCaseFQN}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestCaseResolutionStatusWithHttpInfo(@QueryMap(encoded=true) GetTestCaseResolutionStatusQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getTestCaseResolutionStatus method in a fluent style.
*/
public static class GetTestCaseResolutionStatusQueryParams extends HashMap {
public GetTestCaseResolutionStatusQueryParams testCaseId(final UUID value) {
put("testCaseId", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams offset(final String value) {
put("offset", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams startTs(final BigDecimal value) {
put("startTs", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams endTs(final BigDecimal value) {
put("endTs", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams testCaseResolutionStatusType(final String value) {
put("testCaseResolutionStatusType", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams latest(final Boolean value) {
put("latest", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams assignee(final String value) {
put("assignee", EncodingUtils.encode(value));
return this;
}
public GetTestCaseResolutionStatusQueryParams testCaseFQN(final String value) {
put("testCaseFQN", EncodingUtils.encode(value));
return this;
}
}
/**
* Get test case failure status by id
* Get a test case failure status by id
* @param id Test Case Failure Status ID (required)
* @return TestCaseResolutionStatus
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus/{id}")
@Headers({
"Accept: application/json",
})
TestCaseResolutionStatus getTestCaseResolutionStatusById(@Param("id") UUID id);
/**
* Get test case failure status by id
* Similar to getTestCaseResolutionStatusById but it also returns the http response headers .
* Get a test case failure status by id
* @param id Test Case Failure Status ID (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestCaseResolutionStatusByIdWithHttpInfo(@Param("id") UUID id);
/**
* Get test case failure statuses for a sequence id
* Get a test case failure statuses for a sequence id
* @param stateId Sequence ID (required)
* @return TestCaseResolutionStatus
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus/stateId/{stateId}")
@Headers({
"Accept: application/json",
})
TestCaseResolutionStatus getTestCaseResolutionStatusesForAStateId(@Param("stateId") UUID stateId);
/**
* Get test case failure statuses for a sequence id
* Similar to getTestCaseResolutionStatusesForAStateId but it also returns the http response headers .
* Get a test case failure statuses for a sequence id
* @param stateId Sequence ID (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/testCaseIncidentStatus/stateId/{stateId}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestCaseResolutionStatusesForAStateIdWithHttpInfo(@Param("stateId") UUID stateId);
/**
* Update an existing test case failure status
* Update an existing test case failure status
* @param id Id of the test case result status (required)
* @param body JsonPatch with array of operations. Only `updateAt` and `updatedBy` fields can be patched. (optional)
* JsonPatch RFC
* @see Update an existing test case failure status Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testCases/testCaseIncidentStatus/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void updateTestCaseResolutionStatus(@Param("id") UUID id, Object body);
/**
* Update an existing test case failure status
* Similar to updateTestCaseResolutionStatus but it also returns the http response headers .
* Update an existing test case failure status
* @param id Id of the test case result status (required)
* @param body JsonPatch with array of operations. Only `updateAt` and `updatedBy` fields can be patched. (optional)
* JsonPatch RFC
* @see Update an existing test case failure status Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testCases/testCaseIncidentStatus/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse updateTestCaseResolutionStatusWithHttpInfo(@Param("id") UUID id, Object body);
}