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.CreateLogicalTestCases;
import org.openmetadata.client.model.CreateTestCase;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.TableData;
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 org.openmetadata.client.model.TestSuite;
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-09-25T06:10:38.496414726Z[Etc/UTC]")
public interface TestCasesApi extends ApiClient.Api {
/**
* Add failed rows sample data
* Add a sample of failed rows for this test case.
* @param id Id of the test case (required)
* @param validate (optional, default to true)
* @param tableData (optional)
* @return TestCase
*/
@RequestLine("PUT /v1/dataQuality/testCases/{id}/failedRowsSample?validate={validate}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestCase addFailedRowsSample(@Param("id") UUID id, @Param("validate") Boolean validate, TableData tableData);
/**
* Add failed rows sample data
* Similar to addFailedRowsSample but it also returns the http response headers .
* Add a sample of failed rows for this test case.
* @param id Id of the test case (required)
* @param validate (optional, default to true)
* @param tableData (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testCases/{id}/failedRowsSample?validate={validate}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addFailedRowsSampleWithHttpInfo(@Param("id") UUID id, @Param("validate") Boolean validate, TableData tableData);
/**
* Add failed rows sample data
* Add a sample of failed rows for this test case.
* Note, this is equivalent to the other addFailedRowsSample 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 AddFailedRowsSampleQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the test case (required)
* @param tableData (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - validate - (optional, default to true)
*
* @return TestCase
*/
@RequestLine("PUT /v1/dataQuality/testCases/{id}/failedRowsSample?validate={validate}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestCase addFailedRowsSample(@Param("id") UUID id, TableData tableData, @QueryMap(encoded=true) AddFailedRowsSampleQueryParams queryParams);
/**
* Add failed rows sample data
* Add a sample of failed rows for this test case.
* Note, this is equivalent to the other addFailedRowsSample 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 tableData (optional)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - validate - (optional, default to true)
*
* @return TestCase
*/
@RequestLine("PUT /v1/dataQuality/testCases/{id}/failedRowsSample?validate={validate}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addFailedRowsSampleWithHttpInfo(@Param("id") UUID id, TableData tableData, @QueryMap(encoded=true) AddFailedRowsSampleQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* addFailedRowsSample method in a fluent style.
*/
public static class AddFailedRowsSampleQueryParams extends HashMap {
public AddFailedRowsSampleQueryParams validate(final Boolean value) {
put("validate", EncodingUtils.encode(value));
return this;
}
}
/**
* Add inspection query data
* Add an inspection query for this test case.
* @param id Id of the test case (required)
* @param body (optional)
* @return TestCase
*/
@RequestLine("PUT /v1/dataQuality/testCases/{id}/inspectionQuery")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestCase addInspectionQuery(@Param("id") UUID id, String body);
/**
* Add inspection query data
* Similar to addInspectionQuery but it also returns the http response headers .
* Add an inspection query for this test case.
* @param id Id of the test case (required)
* @param body (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testCases/{id}/inspectionQuery")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addInspectionQueryWithHttpInfo(@Param("id") UUID id, String body);
/**
* 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);
/**
* Add test cases to a logical test suite
* Add test cases to a logical test suite.
* @param createLogicalTestCases (optional)
* @return TestSuite
*/
@RequestLine("PUT /v1/dataQuality/testCases/logicalTestCases")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestSuite addTestCasesToLogicalTestSuite(CreateLogicalTestCases createLogicalTestCases);
/**
* Add test cases to a logical test suite
* Similar to addTestCasesToLogicalTestSuite but it also returns the http response headers .
* Add test cases to a logical test suite.
* @param createLogicalTestCases (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testCases/logicalTestCases")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse addTestCasesToLogicalTestSuiteWithHttpInfo(CreateLogicalTestCases createLogicalTestCases);
/**
* 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 failed rows sample data
* Delete a sample of failed rows for this test case.
* @param id Id of the table (required)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}/failedRowsSample")
@Headers({
"Accept: application/json",
})
void deleteFailedRowsSample(@Param("id") UUID id);
/**
* Delete failed rows sample data
* Similar to deleteFailedRowsSample but it also returns the http response headers .
* Delete a sample of failed rows for this test case.
* @param id Id of the table (required)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}/failedRowsSample")
@Headers({
"Accept: application/json",
})
ApiResponse deleteFailedRowsSampleWithHttpInfo(@Param("id") UUID id);
/**
* Delete a logical test case by Id from a test suite
* Delete a logical test case by `Id` a test suite.
* @param testSuiteId (required)
* @param id (required)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/logicalTestCases/{testSuiteId}/{id}")
@Headers({
"Accept: application/json",
})
void deleteLogicalTestCase(@Param("testSuiteId") UUID testSuiteId, @Param("id") UUID id);
/**
* Delete a logical test case by Id from a test suite
* Similar to deleteLogicalTestCase but it also returns the http response headers .
* Delete a logical test case by `Id` a test suite.
* @param testSuiteId (required)
* @param id (required)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/logicalTestCases/{testSuiteId}/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLogicalTestCaseWithHttpInfo(@Param("testSuiteId") UUID testSuiteId, @Param("id") UUID id);
/**
* 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)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteTestCase(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* 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)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseWithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteTestCase(@Param("id") UUID id, @QueryMap(encoded=true) DeleteTestCaseQueryParams 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/{id}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteTestCaseQueryParams 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;
}
public DeleteTestCaseQueryParams recursive(final Boolean value) {
put("recursive", 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)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteTestCaseByName(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* 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)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseByNameWithHttpInfo(@Param("fqn") String fqn, @Param("hardDelete") Boolean hardDelete, @Param("recursive") Boolean recursive);
/**
* 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
void deleteTestCaseByName(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteTestCaseByNameQueryParams 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)
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testCases/name/{fqn}?hardDelete={hardDelete}&recursive={recursive}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestCaseByNameWithHttpInfo(@Param("fqn") String fqn, @QueryMap(encoded=true) DeleteTestCaseByNameQueryParams 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;
}
public DeleteTestCaseByNameQueryParams recursive(final Boolean value) {
put("recursive", 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 get3(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test case by Id
* Similar to get3 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 get3WithHttpInfo(@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 get3 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 Get3QueryParams} 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 get3(@Param("id") UUID id, @QueryMap(encoded=true) Get3QueryParams queryParams);
/**
* Get a test case by Id
* Get a TestCase by `Id`.
* Note, this is equivalent to the other get3 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 get3WithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) Get3QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* get3 method in a fluent style.
*/
public static class Get3QueryParams extends HashMap {
public Get3QueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public Get3QueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get failed rows sample data
* Get a sample of failed rows for this test case.
* @param id Id of the table (required)
* @return TableData
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}/failedRowsSample")
@Headers({
"Accept: application/json",
})
TableData getFailedRowsSample(@Param("id") UUID id);
/**
* Get failed rows sample data
* Similar to getFailedRowsSample but it also returns the http response headers .
* Get a sample of failed rows for this test case.
* @param id Id of the table (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/{id}/failedRowsSample")
@Headers({
"Accept: application/json",
})
ApiResponse getFailedRowsSampleWithHttpInfo(@Param("id") UUID id);
/**
* 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) GetTestCaseByNameQueryParams 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) GetTestCaseByNameQueryParams 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) ListTestCaseResultsQueryParams 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) ListTestCaseResultsQueryParams 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.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* @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)
* @param testCaseStatus Filter test case by status (optional)
* @param testCaseType Filter for test case type (e.g. column, table, all (optional, default to all)
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases?fields={fields}&limit={limit}&before={before}&after={after}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}")
@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, @Param("testCaseStatus") String testCaseStatus, @Param("testCaseType") String testCaseType);
/**
* 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.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* @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)
* @param testCaseStatus Filter test case by status (optional)
* @param testCaseType Filter for test case type (e.g. column, table, all (optional, default to all)
* @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}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}")
@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, @Param("testCaseStatus") String testCaseStatus, @Param("testCaseType") String testCaseType);
/**
* 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.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* 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)
* - testCaseStatus - Filter test case by status (optional)
* - testCaseType - Filter for test case type (e.g. column, table, all (optional, default to all)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases?fields={fields}&limit={limit}&before={before}&after={after}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}")
@Headers({
"Accept: application/json",
})
TestCaseList listTestCases(@QueryMap(encoded=true) ListTestCasesQueryParams 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.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* 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)
* - testCaseStatus - Filter test case by status (optional)
* - testCaseType - Filter for test case type (e.g. column, table, all (optional, default to all)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases?fields={fields}&limit={limit}&before={before}&after={after}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestCasesWithHttpInfo(@QueryMap(encoded=true) ListTestCasesQueryParams 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;
}
public ListTestCasesQueryParams testCaseStatus(final String value) {
put("testCaseStatus", EncodingUtils.encode(value));
return this;
}
public ListTestCasesQueryParams testCaseType(final String value) {
put("testCaseType", EncodingUtils.encode(value));
return this;
}
}
/**
* List test cases using search service
* Get a list of test cases using the search service. Use `fields` parameter to get only necessary fields. Use offset/limit pagination to limit the number entries in the list using `limit` and `offset` query params.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* @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 offset Returns list of tests after this offset (optional, default to 0)
* @param entityLink Return list of tests by entity link (optional)
* @param testSuiteId Returns list of tests filtered by a 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)
* @param testCaseStatus Filter test case by status (optional)
* @param testCaseType Filter for test case type (e.g. column, table, all) (optional, default to all)
* @param testPlatforms Filter for test case by source (e.g. OpenMetadata, dbt, etc.) (optional)
* @param dataQualityDimension Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.) (optional)
* @param startTimestamp Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `endTimestamp` (optional)
* @param endTimestamp Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `startTimestamp` (optional)
* @param sortField Field used to sort the test cases listing (optional)
* @param sortNestedPath Set this field if your mapping is nested and you want to sort on a nested field (optional)
* @param sortNestedMode Set this field if your mapping is nested and you want to sort on a nested field (optional)
* @param sortType Sort type (optional, default to desc)
* @param includeFields Return only required fields in the response (optional)
* @param domain domain filter to use in list (optional)
* @param owner owner filter to use in list (optional)
* @param tags tags filter to use in list (optional)
* @param tier tier filter to use in list (optional)
* @param serviceName service filter to use in list (optional)
* @param q search query term to use in list (optional)
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases/search/list?fields={fields}&limit={limit}&offset={offset}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}&testPlatforms={testPlatforms}&dataQualityDimension={dataQualityDimension}&startTimestamp={startTimestamp}&endTimestamp={endTimestamp}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&includeFields={includeFields}&domain={domain}&owner={owner}&tags={tags}&tier={tier}&serviceName={serviceName}&q={q}")
@Headers({
"Accept: application/json",
})
TestCaseList listTestCasesFromSearchService(@Param("fields") String fields, @Param("limit") Integer limit, @Param("offset") String offset, @Param("entityLink") String entityLink, @Param("testSuiteId") String testSuiteId, @Param("includeAllTests") Boolean includeAllTests, @Param("include") String include, @Param("testCaseStatus") String testCaseStatus, @Param("testCaseType") String testCaseType, @Param("testPlatforms") String testPlatforms, @Param("dataQualityDimension") String dataQualityDimension, @Param("startTimestamp") Long startTimestamp, @Param("endTimestamp") Long endTimestamp, @Param("sortField") String sortField, @Param("sortNestedPath") String sortNestedPath, @Param("sortNestedMode") String sortNestedMode, @Param("sortType") String sortType, @Param("includeFields") String includeFields, @Param("domain") String domain, @Param("owner") String owner, @Param("tags") String tags, @Param("tier") String tier, @Param("serviceName") String serviceName, @Param("q") String q);
/**
* List test cases using search service
* Similar to listTestCasesFromSearchService but it also returns the http response headers .
* Get a list of test cases using the search service. Use `fields` parameter to get only necessary fields. Use offset/limit pagination to limit the number entries in the list using `limit` and `offset` query params.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* @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 offset Returns list of tests after this offset (optional, default to 0)
* @param entityLink Return list of tests by entity link (optional)
* @param testSuiteId Returns list of tests filtered by a 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)
* @param testCaseStatus Filter test case by status (optional)
* @param testCaseType Filter for test case type (e.g. column, table, all) (optional, default to all)
* @param testPlatforms Filter for test case by source (e.g. OpenMetadata, dbt, etc.) (optional)
* @param dataQualityDimension Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.) (optional)
* @param startTimestamp Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `endTimestamp` (optional)
* @param endTimestamp Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `startTimestamp` (optional)
* @param sortField Field used to sort the test cases listing (optional)
* @param sortNestedPath Set this field if your mapping is nested and you want to sort on a nested field (optional)
* @param sortNestedMode Set this field if your mapping is nested and you want to sort on a nested field (optional)
* @param sortType Sort type (optional, default to desc)
* @param includeFields Return only required fields in the response (optional)
* @param domain domain filter to use in list (optional)
* @param owner owner filter to use in list (optional)
* @param tags tags filter to use in list (optional)
* @param tier tier filter to use in list (optional)
* @param serviceName service filter to use in list (optional)
* @param q search query term to use in list (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testCases/search/list?fields={fields}&limit={limit}&offset={offset}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}&testPlatforms={testPlatforms}&dataQualityDimension={dataQualityDimension}&startTimestamp={startTimestamp}&endTimestamp={endTimestamp}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&includeFields={includeFields}&domain={domain}&owner={owner}&tags={tags}&tier={tier}&serviceName={serviceName}&q={q}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestCasesFromSearchServiceWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("offset") String offset, @Param("entityLink") String entityLink, @Param("testSuiteId") String testSuiteId, @Param("includeAllTests") Boolean includeAllTests, @Param("include") String include, @Param("testCaseStatus") String testCaseStatus, @Param("testCaseType") String testCaseType, @Param("testPlatforms") String testPlatforms, @Param("dataQualityDimension") String dataQualityDimension, @Param("startTimestamp") Long startTimestamp, @Param("endTimestamp") Long endTimestamp, @Param("sortField") String sortField, @Param("sortNestedPath") String sortNestedPath, @Param("sortNestedMode") String sortNestedMode, @Param("sortType") String sortType, @Param("includeFields") String includeFields, @Param("domain") String domain, @Param("owner") String owner, @Param("tags") String tags, @Param("tier") String tier, @Param("serviceName") String serviceName, @Param("q") String q);
/**
* List test cases using search service
* Get a list of test cases using the search service. Use `fields` parameter to get only necessary fields. Use offset/limit pagination to limit the number entries in the list using `limit` and `offset` query params.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* Note, this is equivalent to the other listTestCasesFromSearchService 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 ListTestCasesFromSearchServiceQueryParams} 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)
* - offset - Returns list of tests after this offset (optional, default to 0)
* - entityLink - Return list of tests by entity link (optional)
* - testSuiteId - Returns list of tests filtered by a 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)
* - testCaseStatus - Filter test case by status (optional)
* - testCaseType - Filter for test case type (e.g. column, table, all) (optional, default to all)
* - testPlatforms - Filter for test case by source (e.g. OpenMetadata, dbt, etc.) (optional)
* - dataQualityDimension - Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.) (optional)
* - startTimestamp - Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `endTimestamp` (optional)
* - endTimestamp - Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `startTimestamp` (optional)
* - sortField - Field used to sort the test cases listing (optional)
* - sortNestedPath - Set this field if your mapping is nested and you want to sort on a nested field (optional)
* - sortNestedMode - Set this field if your mapping is nested and you want to sort on a nested field (optional)
* - sortType - Sort type (optional, default to desc)
* - includeFields - Return only required fields in the response (optional)
* - domain - domain filter to use in list (optional)
* - owner - owner filter to use in list (optional)
* - tags - tags filter to use in list (optional)
* - tier - tier filter to use in list (optional)
* - serviceName - service filter to use in list (optional)
* - q - search query term to use in list (optional)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases/search/list?fields={fields}&limit={limit}&offset={offset}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}&testPlatforms={testPlatforms}&dataQualityDimension={dataQualityDimension}&startTimestamp={startTimestamp}&endTimestamp={endTimestamp}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&includeFields={includeFields}&domain={domain}&owner={owner}&tags={tags}&tier={tier}&serviceName={serviceName}&q={q}")
@Headers({
"Accept: application/json",
})
TestCaseList listTestCasesFromSearchService(@QueryMap(encoded=true) ListTestCasesFromSearchServiceQueryParams queryParams);
/**
* List test cases using search service
* Get a list of test cases using the search service. Use `fields` parameter to get only necessary fields. Use offset/limit pagination to limit the number entries in the list using `limit` and `offset` query params.Use the `testSuite` field to get the executable Test Suite linked to this test case or use the `testSuites` field to list test suites (executable and logical) linked.
* Note, this is equivalent to the other listTestCasesFromSearchService 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)
* - offset - Returns list of tests after this offset (optional, default to 0)
* - entityLink - Return list of tests by entity link (optional)
* - testSuiteId - Returns list of tests filtered by a 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)
* - testCaseStatus - Filter test case by status (optional)
* - testCaseType - Filter for test case type (e.g. column, table, all) (optional, default to all)
* - testPlatforms - Filter for test case by source (e.g. OpenMetadata, dbt, etc.) (optional)
* - dataQualityDimension - Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.) (optional)
* - startTimestamp - Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `endTimestamp` (optional)
* - endTimestamp - Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with `startTimestamp` (optional)
* - sortField - Field used to sort the test cases listing (optional)
* - sortNestedPath - Set this field if your mapping is nested and you want to sort on a nested field (optional)
* - sortNestedMode - Set this field if your mapping is nested and you want to sort on a nested field (optional)
* - sortType - Sort type (optional, default to desc)
* - includeFields - Return only required fields in the response (optional)
* - domain - domain filter to use in list (optional)
* - owner - owner filter to use in list (optional)
* - tags - tags filter to use in list (optional)
* - tier - tier filter to use in list (optional)
* - serviceName - service filter to use in list (optional)
* - q - search query term to use in list (optional)
*
* @return TestCaseList
*/
@RequestLine("GET /v1/dataQuality/testCases/search/list?fields={fields}&limit={limit}&offset={offset}&entityLink={entityLink}&testSuiteId={testSuiteId}&includeAllTests={includeAllTests}&include={include}&testCaseStatus={testCaseStatus}&testCaseType={testCaseType}&testPlatforms={testPlatforms}&dataQualityDimension={dataQualityDimension}&startTimestamp={startTimestamp}&endTimestamp={endTimestamp}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&includeFields={includeFields}&domain={domain}&owner={owner}&tags={tags}&tier={tier}&serviceName={serviceName}&q={q}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestCasesFromSearchServiceWithHttpInfo(@QueryMap(encoded=true) ListTestCasesFromSearchServiceQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listTestCasesFromSearchService method in a fluent style.
*/
public static class ListTestCasesFromSearchServiceQueryParams extends HashMap {
public ListTestCasesFromSearchServiceQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams offset(final String value) {
put("offset", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams entityLink(final String value) {
put("entityLink", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams testSuiteId(final String value) {
put("testSuiteId", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams includeAllTests(final Boolean value) {
put("includeAllTests", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams testCaseStatus(final String value) {
put("testCaseStatus", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams testCaseType(final String value) {
put("testCaseType", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams testPlatforms(final String value) {
put("testPlatforms", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams dataQualityDimension(final String value) {
put("dataQualityDimension", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams startTimestamp(final Long value) {
put("startTimestamp", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams endTimestamp(final Long value) {
put("endTimestamp", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams sortField(final String value) {
put("sortField", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams sortNestedPath(final String value) {
put("sortNestedPath", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams sortNestedMode(final String value) {
put("sortNestedMode", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams sortType(final String value) {
put("sortType", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams includeFields(final String value) {
put("includeFields", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams domain(final String value) {
put("domain", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams owner(final String value) {
put("owner", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams tags(final String value) {
put("tags", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams tier(final String value) {
put("tier", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams serviceName(final String value) {
put("serviceName", EncodingUtils.encode(value));
return this;
}
public ListTestCasesFromSearchServiceQueryParams q(final String value) {
put("q", 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);
/**
* Update a test case result
* Update an existing test case using JsonPatch.
* @param fqn fqn of the test case (required)
* @param timestamp Timestamp of the testCase result (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a test case result Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testCases/{fqn}/testCaseResult/{timestamp}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchTestCaseResult(@Param("fqn") String fqn, @Param("timestamp") Long timestamp, Object body);
/**
* Update a test case result
* Similar to patchTestCaseResult but it also returns the http response headers .
* Update an existing test case using JsonPatch.
* @param fqn fqn of the test case (required)
* @param timestamp Timestamp of the testCase result (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a test case result Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testCases/{fqn}/testCaseResult/{timestamp}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchTestCaseResultWithHttpInfo(@Param("fqn") String fqn, @Param("timestamp") Long timestamp, 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 restore12(RestoreEntity restoreEntity);
/**
* Restore a soft deleted test case
* Similar to restore12 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 restore12WithHttpInfo(RestoreEntity restoreEntity);
}