org.openmetadata.client.api.TestCasesApi 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.CreateTestCase;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.TestCase;
import org.openmetadata.client.model.TestCaseList;
import org.openmetadata.client.model.TestCaseResult;
import org.openmetadata.client.model.TestCaseResultList;
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 = "2023-06-06T17:05:44.995298Z[Etc/UTC]")
public interface TestCasesApi extends ApiClient.Api {
/**
* Add test case result data
* Add test case result data to the testCase.
* @param fqn Fully qualified name of the test case (required)
* @param testCaseResult (optional)
* @return TestCase
*/
@RequestLine("PUT /v1/dataQuality/testCases/{fqn}/testCaseResult")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestCase addTestCaseResult(@Param("fqn") String fqn, TestCaseResult testCaseResult);
/**
* Add test case result data
* Similar to addTestCaseResult but it also returns the http response headers .
* Add test case result data to the testCase.
* @param fqn Fully qualified name of the test case (required)
* @param testCaseResult (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testCases/{fqn}/testCaseResult")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addTestCaseResultWithHttpInfo(@Param("fqn") String fqn, TestCaseResult testCaseResult);
/**
* Update test case
* Create a TestCase, it it does not exist or update an existing TestCase.
* @param createTestCase (optional)
* @return TestCase
*/
@RequestLine("PUT /v1/dataQuality/testCases")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestCase createOrUpdateTest(CreateTestCase createTestCase);
/**
* Update test case
* Similar to createOrUpdateTest but it also returns the http response headers .
* Create a TestCase, it it does not exist or update an existing TestCase.
* @param createTestCase (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testCases")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateTestWithHttpInfo(CreateTestCase createTestCase);
/**
* Create a test case
* Create a test case
* @param createTestCase (optional)
* @return TestCase
*/
@RequestLine("POST /v1/dataQuality/testCases")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestCase createTestCase(CreateTestCase createTestCase);
/**
* Create a test case
* Similar to createTestCase but it also returns the http response headers .
* Create a test case
* @param createTestCase (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/dataQuality/testCases")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createTestCaseWithHttpInfo(CreateTestCase createTestCase);
/**
* Delete a test case by Id
* Delete a test case by `Id`.
* @param id Id of the test case (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestCase(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test case by Id
* Similar to deleteTestCase but it also returns the http response headers .
* Delete a test case by `Id`.
* @param id Id of the test case (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test case by Id
* Delete a test case by `Id`.
* Note, this is equivalent to the other deleteTestCase 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 DeleteTestCaseQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestCase(@Param("id") UUID id, @QueryMap(encoded=true) Map queryParams);
/**
* Delete a test case by Id
* Delete a test case by `Id`.
* Note, this is equivalent to the other deleteTestCase that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) Map queryParams);
/**
* A convenience class for generating query parameters for the
* deleteTestCase method in a fluent style.
*/
public static class DeleteTestCaseQueryParams extends HashMap {
public DeleteTestCaseQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a test case by fully qualified name
* Delete a testCase by `fullyQualifiedName`.
* @param fqn Fully qualified name of the test case (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestCaseByName(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test case by fully qualified name
* Similar to deleteTestCaseByName but it also returns the http response headers .
* Delete a testCase by `fullyQualifiedName`.
* @param fqn Fully qualified name of the test case (required)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseByNameWithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test case by fully qualified name
* Delete a testCase by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteTestCaseByName 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 DeleteTestCaseByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestCaseByName(@Param("fqn") String fqn, @QueryMap(encoded=true) Map queryParams);
/**
* Delete a test case by fully qualified name
* Delete a testCase by `fullyQualifiedName`.
* Note, this is equivalent to the other deleteTestCaseByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseByNameWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) Map queryParams);
/**
* A convenience class for generating query parameters for the
* deleteTestCaseByName method in a fluent style.
*/
public static class DeleteTestCaseByNameQueryParams extends HashMap {
public DeleteTestCaseByNameQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete test case result
* Delete testCase result for a testCase.
* @param fqn Fully qualified name of the test case (required)
* @param timestamp Timestamp of the testCase result (required)
* @return TestCase
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{fqn}/testCaseResult/{timestamp}")
@Headers({
"Accept: application/json",
})
TestCase deleteTestCaseResult(@Param("fqn") String fqn, @Param("timestamp") Long timestamp);
/**
* Delete test case result
* Similar to deleteTestCaseResult but it also returns the http response headers .
* Delete testCase result for a testCase.
* @param fqn Fully qualified name of the test case (required)
* @param timestamp Timestamp of the testCase result (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{fqn}/testCaseResult/{timestamp}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseResultWithHttpInfo(@Param("fqn") String fqn, @Param("timestamp") Long timestamp);
/**
* Get a test case by Id
* Get a TestCase by `Id`.
* @param id Id of the test case (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return TestCase
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestCase get(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test case by Id
* Similar to get but it also returns the http response headers .
* Get a TestCase by `Id`.
* @param id Id of the test case (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test case by Id
* Get a TestCase by `Id`.
* Note, this is equivalent to the other get 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 GetQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestCase
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestCase get(@Param("id") UUID id, @QueryMap(encoded=true) Map queryParams);
/**
* Get a test case by Id
* Get a TestCase by `Id`.
* Note, this is equivalent to the other get that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestCase
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) Map queryParams);
/**
* A convenience class for generating query parameters for the
* get method in a fluent style.
*/
public static class GetQueryParams extends HashMap {
public GetQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the test case
* Get a version of the test case by given `Id`
* @param id Id of the test case (required)
* @param version Test version number in the form `major`.`minor` (required)
* @return TestCase
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
TestCase getSpecificTestCaseVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the test case
* Similar to getSpecificTestCaseVersion but it also returns the http response headers .
* Get a version of the test case by given `Id`
* @param id Id of the test case (required)
* @param version Test version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificTestCaseVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get a test case by fully qualified name
* Get a test case by `fullyQualifiedName`.
* @param fqn Fully qualified name of the test case (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return TestCase
*/
@RequestLine("GET /v1/dataQuality/testCases/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestCase getTestCaseByName(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test case by fully qualified name
* Similar to getTestCaseByName but it also returns the http response headers .
* Get a test case by `fullyQualifiedName`.
* @param fqn Fully qualified name of the test case (required)
* @param fields Fields requested in the returned resource (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestCaseByNameWithHttpInfo(@Param("fqn") String fqn, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test case by fully qualified name
* Get a test case by `fullyQualifiedName`.
* Note, this is equivalent to the other getTestCaseByName 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 GetTestCaseByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestCase
*/
@RequestLine("GET /v1/dataQuality/testCases/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestCase getTestCaseByName(@Param("fqn") String fqn, @QueryMap(encoded=true) Map queryParams);
/**
* Get a test case by fully qualified name
* Get a test case by `fullyQualifiedName`.
* Note, this is equivalent to the other getTestCaseByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestCase
*/
@RequestLine("GET /v1/dataQuality/testCases/name/{fqn}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestCaseByNameWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) Map queryParams);
/**
* A convenience class for generating query parameters for the
* getTestCaseByName method in a fluent style.
*/
public static class GetTestCaseByNameQueryParams extends HashMap {
public GetTestCaseByNameQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetTestCaseByNameQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* List test case versions
* Get a list of all the versions of a testCases identified by `Id`
* @param id Id of the test case (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllTestCaseVersion(@Param("id") UUID id);
/**
* List test case versions
* Similar to listAllTestCaseVersion but it also returns the http response headers .
* Get a list of all the versions of a testCases identified by `Id`
* @param id Id of the test case (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllTestCaseVersionWithHttpInfo(@Param("id") UUID id);
/**
* List of test case results
* Get a list of all the test case results for the given testCase id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param fqn Fully qualified name of the test case (required)
* @param startTs Filter testCase results after the given start timestamp (optional)
* @param endTs Filter testCase results before the given end timestamp (optional)
* @return TestCaseResultList
*/
@RequestLine("GET /v1/dataQuality/testCases/{fqn}/testCaseResult?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
TestCaseResultList listTestCaseResults(@Param("fqn") String fqn, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List of test case results
* Similar to listTestCaseResults but it also returns the http response headers .
* Get a list of all the test case results for the given testCase id, optionally filtered by `startTs` and `endTs` of the profile. Use cursor-based pagination to limit the number of entries in the list using `limit` and `before` or `after` query params.
* @param fqn Fully qualified name of the test case (required)
* @param startTs Filter testCase results after the given start timestamp (optional)
* @param endTs Filter testCase results before the given end timestamp (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/{fqn}/testCaseResult?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestCaseResultsWithHttpInfo(@Param("fqn") String fqn, @Param("startTs") BigDecimal startTs, @Param("endTs") BigDecimal endTs);
/**
* List of test case results
* Get a list of all the test case results for the given testCase id, optionally filtered by `startTs` and `endTs` of the profile. 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 listTestCaseResults 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 ListTestCaseResultsQueryParams} class that allows for
* building up this map in a fluent style.
* @param fqn Fully qualified name of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - startTs - Filter testCase results after the given start timestamp (optional)
* - endTs - Filter testCase results before the given end timestamp (optional)
*
* @return TestCaseResultList
*/
@RequestLine("GET /v1/dataQuality/testCases/{fqn}/testCaseResult?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
TestCaseResultList listTestCaseResults(@Param("fqn") String fqn, @QueryMap(encoded=true) Map queryParams);
/**
* List of test case results
* Get a list of all the test case results for the given testCase id, optionally filtered by `startTs` and `endTs` of the profile. 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 listTestCaseResults that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param fqn Fully qualified name of the test case (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - startTs - Filter testCase results after the given start timestamp (optional)
* - endTs - Filter testCase results before the given end timestamp (optional)
*
* @return TestCaseResultList
*/
@RequestLine("GET /v1/dataQuality/testCases/{fqn}/testCaseResult?startTs={startTs}&endTs={endTs}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestCaseResultsWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) Map queryParams);
/**
* A convenience class for generating query parameters for the
* listTestCaseResults method in a fluent style.
*/
public static class ListTestCaseResultsQueryParams extends HashMap {
public ListTestCaseResultsQueryParams startTs(final BigDecimal value) {
put("startTs", EncodingUtils.encode(value));
return this;
}
public ListTestCaseResultsQueryParams endTs(final BigDecimal value) {
put("endTs", EncodingUtils.encode(value));
return this;
}
}
/**
* List test cases
* Get a list of test. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of tests before this cursor (optional)
* @param after Returns list of tests after this cursor (optional)
* @param entityLink Return list of tests by entity link (optional)
* @param testSuiteId Returns list of tests filtered by the testSuite id (optional)
* @param includeAllTests Include all the tests at the entity level (optional, default to false)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases?fields={fields}&limit={limit}&before={before}&after={after}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}")
@Headers({
"Accept: application/json",
})
TestCaseList listTestCases(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("entityLink") String entityLink, @Param("testSuiteId") String testSuiteId, @Param("includeAllTests") Boolean includeAllTests, @Param("include") String include);
/**
* List test cases
* Similar to listTestCases but it also returns the http response headers .
* Get a list of test. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param before Returns list of tests before this cursor (optional)
* @param after Returns list of tests after this cursor (optional)
* @param entityLink Return list of tests by entity link (optional)
* @param testSuiteId Returns list of tests filtered by the testSuite id (optional)
* @param includeAllTests Include all the tests at the entity level (optional, default to false)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases?fields={fields}&limit={limit}&before={before}&after={after}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestCasesWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("before") String before, @Param("after") String after, @Param("entityLink") String entityLink, @Param("testSuiteId") String testSuiteId, @Param("includeAllTests") Boolean includeAllTests, @Param("include") String include);
/**
* List test cases
* Get a list of test. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listTestCases 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 ListTestCasesQueryParams} 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:
*
* - fields - Fields requested in the returned resource (optional)
* - limit - Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of tests before this cursor (optional)
* - after - Returns list of tests after this cursor (optional)
* - entityLink - Return list of tests by entity link (optional)
* - testSuiteId - Returns list of tests filtered by the testSuite id (optional)
* - includeAllTests - Include all the tests at the entity level (optional, default to false)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases?fields={fields}&limit={limit}&before={before}&after={after}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}")
@Headers({
"Accept: application/json",
})
TestCaseList listTestCases(@QueryMap(encoded=true) Map queryParams);
/**
* List test cases
* Get a list of test. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params.
* Note, this is equivalent to the other listTestCases 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:
*
* - fields - Fields requested in the returned resource (optional)
* - limit - Limit the number tests returned. (1 to 1000000, default = 10) (optional, default to 10)
* - before - Returns list of tests before this cursor (optional)
* - after - Returns list of tests after this cursor (optional)
* - entityLink - Return list of tests by entity link (optional)
* - testSuiteId - Returns list of tests filtered by the testSuite id (optional)
* - includeAllTests - Include all the tests at the entity level (optional, default to false)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases?fields={fields}&limit={limit}&before={before}&after={after}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestCasesWithHttpInfo(@QueryMap(encoded=true) Map queryParams);
/**
* A convenience class for generating query parameters for the
* listTestCases method in a fluent style.
*/
public static class ListTestCasesQueryParams extends HashMap {
public ListTestCasesQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams entityLink(final String value) {
put("entityLink", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams testSuiteId(final String value) {
put("testSuiteId", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams includeAllTests(final Boolean value) {
put("includeAllTests", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a test case
* Update an existing test using JsonPatch.
* @param id Id of the test case (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a test case Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testCases/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchTest(@Param("id") UUID id, Object body);
/**
* Update a test case
* Similar to patchTest but it also returns the http response headers .
* Update an existing test using JsonPatch.
* @param id Id of the test case (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a test case Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testCases/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchTestWithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted test case
* Restore a soft deleted test case.
* @param restoreEntity (optional)
* @return TestCase
*/
@RequestLine("PUT /v1/dataQuality/testCases/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestCase restore7(RestoreEntity restoreEntity);
/**
* Restore a soft deleted test case
* Similar to restore7 but it also returns the http response headers .
* Restore a soft deleted test case.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testCases/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore7WithHttpInfo(RestoreEntity restoreEntity);
}