org.openmetadata.client.api.TestSuitesApi 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 org.openmetadata.client.model.CreateTestSuite;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.RestoreEntity;
import org.openmetadata.client.model.TestSuite;
import org.openmetadata.client.model.TestSuiteList;
import org.openmetadata.client.model.TestSummary;
import java.util.UUID;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-25T09:42:14.348793228Z[Etc/UTC]")
public interface TestSuitesApi extends ApiClient.Api {
/**
* Create an executable test suite
* Create an executable test suite.
* @param createTestSuite (optional)
* @return TestSuite
*/
@RequestLine("POST /v1/dataQuality/testSuites/executable")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestSuite createExecutableTestSuite(CreateTestSuite createTestSuite);
/**
* Create an executable test suite
* Similar to createExecutableTestSuite but it also returns the http response headers .
* Create an executable test suite.
* @param createTestSuite (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/dataQuality/testSuites/executable")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createExecutableTestSuiteWithHttpInfo(CreateTestSuite createTestSuite);
/**
* Create a logical test suite
* Create a logical test suite.
* @param createTestSuite (optional)
* @return TestSuite
*/
@RequestLine("POST /v1/dataQuality/testSuites")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestSuite createLogicalTestSuite(CreateTestSuite createTestSuite);
/**
* Create a logical test suite
* Similar to createLogicalTestSuite but it also returns the http response headers .
* Create a logical test suite.
* @param createTestSuite (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/dataQuality/testSuites")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createLogicalTestSuiteWithHttpInfo(CreateTestSuite createTestSuite);
/**
* Create or Update Executable test suite
* Create an Executable TestSuite if it does not exist or update an existing one.
* @param createTestSuite (optional)
* @return TestSuite
*/
@RequestLine("PUT /v1/dataQuality/testSuites/executable")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestSuite createOrUpdateExecutableTestSuite(CreateTestSuite createTestSuite);
/**
* Create or Update Executable test suite
* Similar to createOrUpdateExecutableTestSuite but it also returns the http response headers .
* Create an Executable TestSuite if it does not exist or update an existing one.
* @param createTestSuite (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testSuites/executable")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateExecutableTestSuiteWithHttpInfo(CreateTestSuite createTestSuite);
/**
* Update logical test suite
* Create a logical TestSuite, if it does not exist or update an existing test suite.
* @param createTestSuite (optional)
* @return TestSuite
*/
@RequestLine("PUT /v1/dataQuality/testSuites")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestSuite createOrUpdateLogicalTestSuite(CreateTestSuite createTestSuite);
/**
* Update logical test suite
* Similar to createOrUpdateLogicalTestSuite but it also returns the http response headers .
* Create a logical TestSuite, if it does not exist or update an existing test suite.
* @param createTestSuite (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testSuites")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateLogicalTestSuiteWithHttpInfo(CreateTestSuite createTestSuite);
/**
* Delete a logical test suite
* Delete a logical test suite by `name`.
* @param name FQN of the logical test suite (required)
* @param hardDelete Hard delete the logical entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteLogicalTestSuite(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a logical test suite
* Similar to deleteLogicalTestSuite but it also returns the http response headers .
* Delete a logical test suite by `name`.
* @param name FQN of the logical test suite (required)
* @param hardDelete Hard delete the logical entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLogicalTestSuiteWithHttpInfo(@Param("name") String name, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a logical test suite
* Delete a logical test suite by `name`.
* Note, this is equivalent to the other deleteLogicalTestSuite 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 DeleteLogicalTestSuiteQueryParams} class that allows for
* building up this map in a fluent style.
* @param name FQN of the logical test suite (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 logical entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteLogicalTestSuite(@Param("name") String name, @QueryMap(encoded=true) DeleteLogicalTestSuiteQueryParams queryParams);
/**
* Delete a logical test suite
* Delete a logical test suite by `name`.
* Note, this is equivalent to the other deleteLogicalTestSuite that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name FQN of the logical test suite (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 logical entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/name/{name}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLogicalTestSuiteWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) DeleteLogicalTestSuiteQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteLogicalTestSuite method in a fluent style.
*/
public static class DeleteLogicalTestSuiteQueryParams extends HashMap {
public DeleteLogicalTestSuiteQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a logical test suite
* Delete a logical test suite by `id`.
* @param id Id of the logical test suite (required)
* @param hardDelete Hard delete the logical entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteLogicalTestSuite1(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a logical test suite
* Similar to deleteLogicalTestSuite1 but it also returns the http response headers .
* Delete a logical test suite by `id`.
* @param id Id of the logical test suite (required)
* @param hardDelete Hard delete the logical entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLogicalTestSuite1WithHttpInfo(@Param("id") UUID id, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a logical test suite
* Delete a logical test suite by `id`.
* Note, this is equivalent to the other deleteLogicalTestSuite1 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 DeleteLogicalTestSuite1QueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the logical test suite (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 logical entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteLogicalTestSuite1(@Param("id") UUID id, @QueryMap(encoded=true) DeleteLogicalTestSuite1QueryParams queryParams);
/**
* Delete a logical test suite
* Delete a logical test suite by `id`.
* Note, this is equivalent to the other deleteLogicalTestSuite1 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the logical test suite (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 logical entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/{id}?hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteLogicalTestSuite1WithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteLogicalTestSuite1QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteLogicalTestSuite1 method in a fluent style.
*/
public static class DeleteLogicalTestSuite1QueryParams extends HashMap {
public DeleteLogicalTestSuite1QueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a test suite
* Delete a test suite by `Id`.
* @param id Id of the test suite (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestSuite(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test suite
* Similar to deleteTestSuite but it also returns the http response headers .
* Delete a test suite by `Id`.
* @param id Id of the test suite (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestSuiteWithHttpInfo(@Param("id") UUID id, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test suite
* Delete a test suite by `Id`.
* Note, this is equivalent to the other deleteTestSuite 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 DeleteTestSuiteQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the test suite (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestSuite(@Param("id") UUID id, @QueryMap(encoded=true) DeleteTestSuiteQueryParams queryParams);
/**
* Delete a test suite
* Delete a test suite by `Id`.
* Note, this is equivalent to the other deleteTestSuite that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the test suite (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/{id}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestSuiteWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) DeleteTestSuiteQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteTestSuite method in a fluent style.
*/
public static class DeleteTestSuiteQueryParams extends HashMap {
public DeleteTestSuiteQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
public DeleteTestSuiteQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Delete a test suite
* Delete a test suite by `name`.
* @param name Name of the test suite (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/name/{name}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestSuiteByName(@Param("name") String name, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test suite
* Similar to deleteTestSuiteByName but it also returns the http response headers .
* Delete a test suite by `name`.
* @param name Name of the test suite (required)
* @param recursive Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* @param hardDelete Hard delete the entity. (Default = `false`) (optional, default to false)
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/name/{name}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestSuiteByNameWithHttpInfo(@Param("name") String name, @Param("recursive") Boolean recursive, @Param("hardDelete") Boolean hardDelete);
/**
* Delete a test suite
* Delete a test suite by `name`.
* Note, this is equivalent to the other deleteTestSuiteByName 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 DeleteTestSuiteByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the test suite (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/name/{name}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
void deleteTestSuiteByName(@Param("name") String name, @QueryMap(encoded=true) DeleteTestSuiteByNameQueryParams queryParams);
/**
* Delete a test suite
* Delete a test suite by `name`.
* Note, this is equivalent to the other deleteTestSuiteByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the test suite (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - recursive - Recursively delete this entity and it's children. (Default `false`) (optional, default to false)
* - hardDelete - Hard delete the entity. (Default = `false`) (optional, default to false)
*
*/
@RequestLine("DELETE /v1/dataQuality/testSuites/executable/name/{name}?recursive={recursive}&hardDelete={hardDelete}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteTestSuiteByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) DeleteTestSuiteByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* deleteTestSuiteByName method in a fluent style.
*/
public static class DeleteTestSuiteByNameQueryParams extends HashMap {
public DeleteTestSuiteByNameQueryParams recursive(final Boolean value) {
put("recursive", EncodingUtils.encode(value));
return this;
}
public DeleteTestSuiteByNameQueryParams hardDelete(final Boolean value) {
put("hardDelete", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a test suite by Id
* Get a Test Suite by `Id`.
* @param id Id of the test suite (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 TestSuite
*/
@RequestLine("GET /v1/dataQuality/testSuites/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestSuite get5(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test suite by Id
* Similar to get5 but it also returns the http response headers .
* Get a Test Suite by `Id`.
* @param id Id of the test suite (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/testSuites/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get5WithHttpInfo(@Param("id") UUID id, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test suite by Id
* Get a Test Suite by `Id`.
* Note, this is equivalent to the other get5 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 Get5QueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the test suite (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 TestSuite
*/
@RequestLine("GET /v1/dataQuality/testSuites/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestSuite get5(@Param("id") UUID id, @QueryMap(encoded=true) Get5QueryParams queryParams);
/**
* Get a test suite by Id
* Get a Test Suite by `Id`.
* Note, this is equivalent to the other get5 that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the test suite (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 TestSuite
*/
@RequestLine("GET /v1/dataQuality/testSuites/{id}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse get5WithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) Get5QueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* get5 method in a fluent style.
*/
public static class Get5QueryParams extends HashMap {
public Get5QueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public Get5QueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Get the execution summary of test suites
* Get the execution summary of test suites.
* @param testSuiteId get summary for a specific test suite (optional)
* @return TestSummary
*/
@RequestLine("GET /v1/dataQuality/testSuites/executionSummary?testSuiteId={testSuiteId}")
@Headers({
"Accept: application/json",
})
TestSummary getExecutionSummaryOfTestSuites(@Param("testSuiteId") UUID testSuiteId);
/**
* Get the execution summary of test suites
* Similar to getExecutionSummaryOfTestSuites but it also returns the http response headers .
* Get the execution summary of test suites.
* @param testSuiteId get summary for a specific test suite (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testSuites/executionSummary?testSuiteId={testSuiteId}")
@Headers({
"Accept: application/json",
})
ApiResponse getExecutionSummaryOfTestSuitesWithHttpInfo(@Param("testSuiteId") UUID testSuiteId);
/**
* Get the execution summary of test suites
* Get the execution summary of test suites.
* Note, this is equivalent to the other getExecutionSummaryOfTestSuites 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 GetExecutionSummaryOfTestSuitesQueryParams} 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:
*
* - testSuiteId - get summary for a specific test suite (optional)
*
* @return TestSummary
*/
@RequestLine("GET /v1/dataQuality/testSuites/executionSummary?testSuiteId={testSuiteId}")
@Headers({
"Accept: application/json",
})
TestSummary getExecutionSummaryOfTestSuites(@QueryMap(encoded=true) GetExecutionSummaryOfTestSuitesQueryParams queryParams);
/**
* Get the execution summary of test suites
* Get the execution summary of test suites.
* Note, this is equivalent to the other getExecutionSummaryOfTestSuites 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:
*
* - testSuiteId - get summary for a specific test suite (optional)
*
* @return TestSummary
*/
@RequestLine("GET /v1/dataQuality/testSuites/executionSummary?testSuiteId={testSuiteId}")
@Headers({
"Accept: application/json",
})
ApiResponse getExecutionSummaryOfTestSuitesWithHttpInfo(@QueryMap(encoded=true) GetExecutionSummaryOfTestSuitesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getExecutionSummaryOfTestSuites method in a fluent style.
*/
public static class GetExecutionSummaryOfTestSuitesQueryParams extends HashMap {
public GetExecutionSummaryOfTestSuitesQueryParams testSuiteId(final UUID value) {
put("testSuiteId", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the test suite
* Get a version of the test suite by given `id`
* @param id Id of the test suite (required)
* @param version Test Suite version number in the form `major`.`minor` (required)
* @return TestSuite
*/
@RequestLine("GET /v1/dataQuality/testSuites/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
TestSuite getSpecificTestSuiteVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the test suite
* Similar to getSpecificTestSuiteVersion but it also returns the http response headers .
* Get a version of the test suite by given `id`
* @param id Id of the test suite (required)
* @param version Test Suite version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testSuites/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificTestSuiteVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get a test suite by name
* Get a test suite by name.
* @param name Name of the test suite (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 TestSuite
*/
@RequestLine("GET /v1/dataQuality/testSuites/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestSuite getTestSuiteByName(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test suite by name
* Similar to getTestSuiteByName but it also returns the http response headers .
* Get a test suite by name.
* @param name Name of the test suite (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/testSuites/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestSuiteByNameWithHttpInfo(@Param("name") String name, @Param("fields") String fields, @Param("include") String include);
/**
* Get a test suite by name
* Get a test suite by name.
* Note, this is equivalent to the other getTestSuiteByName 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 GetTestSuiteByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param name Name of the test suite (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 TestSuite
*/
@RequestLine("GET /v1/dataQuality/testSuites/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
TestSuite getTestSuiteByName(@Param("name") String name, @QueryMap(encoded=true) GetTestSuiteByNameQueryParams queryParams);
/**
* Get a test suite by name
* Get a test suite by name.
* Note, this is equivalent to the other getTestSuiteByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param name Name of the test suite (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 TestSuite
*/
@RequestLine("GET /v1/dataQuality/testSuites/name/{name}?fields={fields}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse getTestSuiteByNameWithHttpInfo(@Param("name") String name, @QueryMap(encoded=true) GetTestSuiteByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getTestSuiteByName method in a fluent style.
*/
public static class GetTestSuiteByNameQueryParams extends HashMap {
public GetTestSuiteByNameQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public GetTestSuiteByNameQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* List test suite versions
* Get a list of all the versions of a test suite identified by `id`
* @param id Id of the test suite (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/dataQuality/testSuites/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllTestSuiteVersion(@Param("id") UUID id);
/**
* List test suite versions
* Similar to listAllTestSuiteVersion but it also returns the http response headers .
* Get a list of all the versions of a test suite identified by `id`
* @param id Id of the test suite (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/dataQuality/testSuites/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllTestSuiteVersionWithHttpInfo(@Param("id") UUID id);
/**
* List test suite using search service
* Get a list of test suite 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 `tests` field to get the test cases linked to the test suite and/or use the `summary` field to get a summary of test case executions.
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number test suite returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param offset Returns list of test suite after this offset (default = 0) (optional, default to 0)
* @param testSuiteType Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* @param includeEmptyTestSuites Include empty test suite in the response. (optional, default to true)
* @param fullyQualifiedName Filter a test suite by fully qualified name. (optional)
* @param owner Filter test suites by owner. (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @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 q search query term to use in list (optional)
* @return TestSuiteList
*/
@RequestLine("GET /v1/dataQuality/testSuites/search/list?fields={fields}&limit={limit}&offset={offset}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&fullyQualifiedName={fullyQualifiedName}&owner={owner}&include={include}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&q={q}")
@Headers({
"Accept: application/json",
})
TestSuiteList listTestSuiteFromSearchService(@Param("fields") String fields, @Param("limit") Integer limit, @Param("offset") String offset, @Param("testSuiteType") String testSuiteType, @Param("includeEmptyTestSuites") Boolean includeEmptyTestSuites, @Param("fullyQualifiedName") String fullyQualifiedName, @Param("owner") String owner, @Param("include") String include, @Param("sortField") String sortField, @Param("sortNestedPath") String sortNestedPath, @Param("sortNestedMode") String sortNestedMode, @Param("sortType") String sortType, @Param("q") String q);
/**
* List test suite using search service
* Similar to listTestSuiteFromSearchService but it also returns the http response headers .
* Get a list of test suite 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 `tests` field to get the test cases linked to the test suite and/or use the `summary` field to get a summary of test case executions.
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number test suite returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param offset Returns list of test suite after this offset (default = 0) (optional, default to 0)
* @param testSuiteType Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* @param includeEmptyTestSuites Include empty test suite in the response. (optional, default to true)
* @param fullyQualifiedName Filter a test suite by fully qualified name. (optional)
* @param owner Filter test suites by owner. (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @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 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/testSuites/search/list?fields={fields}&limit={limit}&offset={offset}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&fullyQualifiedName={fullyQualifiedName}&owner={owner}&include={include}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&q={q}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestSuiteFromSearchServiceWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("offset") String offset, @Param("testSuiteType") String testSuiteType, @Param("includeEmptyTestSuites") Boolean includeEmptyTestSuites, @Param("fullyQualifiedName") String fullyQualifiedName, @Param("owner") String owner, @Param("include") String include, @Param("sortField") String sortField, @Param("sortNestedPath") String sortNestedPath, @Param("sortNestedMode") String sortNestedMode, @Param("sortType") String sortType, @Param("q") String q);
/**
* List test suite using search service
* Get a list of test suite 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 `tests` field to get the test cases linked to the test suite and/or use the `summary` field to get a summary of test case executions.
* Note, this is equivalent to the other listTestSuiteFromSearchService 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 ListTestSuiteFromSearchServiceQueryParams} 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 test suite returned. (1 to 1000000, default = 10) (optional, default to 10)
* - offset - Returns list of test suite after this offset (default = 0) (optional, default to 0)
* - testSuiteType - Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* - includeEmptyTestSuites - Include empty test suite in the response. (optional, default to true)
* - fullyQualifiedName - Filter a test suite by fully qualified name. (optional)
* - owner - Filter test suites by owner. (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* - 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)
* - q - search query term to use in list (optional)
*
* @return TestSuiteList
*/
@RequestLine("GET /v1/dataQuality/testSuites/search/list?fields={fields}&limit={limit}&offset={offset}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&fullyQualifiedName={fullyQualifiedName}&owner={owner}&include={include}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&q={q}")
@Headers({
"Accept: application/json",
})
TestSuiteList listTestSuiteFromSearchService(@QueryMap(encoded=true) ListTestSuiteFromSearchServiceQueryParams queryParams);
/**
* List test suite using search service
* Get a list of test suite 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 `tests` field to get the test cases linked to the test suite and/or use the `summary` field to get a summary of test case executions.
* Note, this is equivalent to the other listTestSuiteFromSearchService 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 test suite returned. (1 to 1000000, default = 10) (optional, default to 10)
* - offset - Returns list of test suite after this offset (default = 0) (optional, default to 0)
* - testSuiteType - Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* - includeEmptyTestSuites - Include empty test suite in the response. (optional, default to true)
* - fullyQualifiedName - Filter a test suite by fully qualified name. (optional)
* - owner - Filter test suites by owner. (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* - 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)
* - q - search query term to use in list (optional)
*
* @return TestSuiteList
*/
@RequestLine("GET /v1/dataQuality/testSuites/search/list?fields={fields}&limit={limit}&offset={offset}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&fullyQualifiedName={fullyQualifiedName}&owner={owner}&include={include}&sortField={sortField}&sortNestedPath={sortNestedPath}&sortNestedMode={sortNestedMode}&sortType={sortType}&q={q}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestSuiteFromSearchServiceWithHttpInfo(@QueryMap(encoded=true) ListTestSuiteFromSearchServiceQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listTestSuiteFromSearchService method in a fluent style.
*/
public static class ListTestSuiteFromSearchServiceQueryParams extends HashMap {
public ListTestSuiteFromSearchServiceQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams offset(final String value) {
put("offset", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams testSuiteType(final String value) {
put("testSuiteType", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams includeEmptyTestSuites(final Boolean value) {
put("includeEmptyTestSuites", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams fullyQualifiedName(final String value) {
put("fullyQualifiedName", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams owner(final String value) {
put("owner", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams sortField(final String value) {
put("sortField", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams sortNestedPath(final String value) {
put("sortNestedPath", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams sortNestedMode(final String value) {
put("sortNestedMode", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams sortType(final String value) {
put("sortType", EncodingUtils.encode(value));
return this;
}
public ListTestSuiteFromSearchServiceQueryParams q(final String value) {
put("q", EncodingUtils.encode(value));
return this;
}
}
/**
* List test suites
* Get a list of test suites. 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 test definitions returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param testSuiteType Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* @param includeEmptyTestSuites Include empty test suite in the response. (optional, default to true)
* @param before Returns list of test definitions before this cursor (optional)
* @param after Returns list of test definitions after this cursor (optional)
* @param include Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
* @return TestSuiteList
*/
@RequestLine("GET /v1/dataQuality/testSuites?fields={fields}&limit={limit}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
TestSuiteList listTestSuites(@Param("fields") String fields, @Param("limit") Integer limit, @Param("testSuiteType") String testSuiteType, @Param("includeEmptyTestSuites") Boolean includeEmptyTestSuites, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List test suites
* Similar to listTestSuites but it also returns the http response headers .
* Get a list of test suites. 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 test definitions returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param testSuiteType Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* @param includeEmptyTestSuites Include empty test suite in the response. (optional, default to true)
* @param before Returns list of test definitions before this cursor (optional)
* @param after Returns list of test definitions after this cursor (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/testSuites?fields={fields}&limit={limit}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestSuitesWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("testSuiteType") String testSuiteType, @Param("includeEmptyTestSuites") Boolean includeEmptyTestSuites, @Param("before") String before, @Param("after") String after, @Param("include") String include);
/**
* List test suites
* Get a list of test suites. 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 listTestSuites 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 ListTestSuitesQueryParams} 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 test definitions returned. (1 to 1000000, default = 10) (optional, default to 10)
* - testSuiteType - Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* - includeEmptyTestSuites - Include empty test suite in the response. (optional, default to true)
* - before - Returns list of test definitions before this cursor (optional)
* - after - Returns list of test definitions after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestSuiteList
*/
@RequestLine("GET /v1/dataQuality/testSuites?fields={fields}&limit={limit}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
TestSuiteList listTestSuites(@QueryMap(encoded=true) ListTestSuitesQueryParams queryParams);
/**
* List test suites
* Get a list of test suites. 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 listTestSuites 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 test definitions returned. (1 to 1000000, default = 10) (optional, default to 10)
* - testSuiteType - Returns executable or logical test suites. If omitted, returns all test suites. (optional)
* - includeEmptyTestSuites - Include empty test suite in the response. (optional, default to true)
* - before - Returns list of test definitions before this cursor (optional)
* - after - Returns list of test definitions after this cursor (optional)
* - include - Include all, deleted, or non-deleted entities. (optional, default to non-deleted)
*
* @return TestSuiteList
*/
@RequestLine("GET /v1/dataQuality/testSuites?fields={fields}&limit={limit}&testSuiteType={testSuiteType}&includeEmptyTestSuites={includeEmptyTestSuites}&before={before}&after={after}&include={include}")
@Headers({
"Accept: application/json",
})
ApiResponse listTestSuitesWithHttpInfo(@QueryMap(encoded=true) ListTestSuitesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listTestSuites method in a fluent style.
*/
public static class ListTestSuitesQueryParams extends HashMap {
public ListTestSuitesQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListTestSuitesQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListTestSuitesQueryParams testSuiteType(final String value) {
put("testSuiteType", EncodingUtils.encode(value));
return this;
}
public ListTestSuitesQueryParams includeEmptyTestSuites(final Boolean value) {
put("includeEmptyTestSuites", EncodingUtils.encode(value));
return this;
}
public ListTestSuitesQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListTestSuitesQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
public ListTestSuitesQueryParams include(final String value) {
put("include", EncodingUtils.encode(value));
return this;
}
}
/**
* Update a test suite
* Update an existing testSuite using JsonPatch.
* @param id Id of the test suite (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a test suite Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testSuites/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchTestSuite(@Param("id") UUID id, Object body);
/**
* Update a test suite
* Similar to patchTestSuite but it also returns the http response headers .
* Update an existing testSuite using JsonPatch.
* @param id Id of the test suite (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update a test suite Documentation
*/
@RequestLine("PATCH /v1/dataQuality/testSuites/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchTestSuiteWithHttpInfo(@Param("id") UUID id, Object body);
/**
* Restore a soft deleted test suite
* Restore a soft deleted test suite.
* @param restoreEntity (optional)
* @return TestSuite
*/
@RequestLine("PUT /v1/dataQuality/testSuites/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
TestSuite restore12(RestoreEntity restoreEntity);
/**
* Restore a soft deleted test suite
* Similar to restore12 but it also returns the http response headers .
* Restore a soft deleted test suite.
* @param restoreEntity (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/dataQuality/testSuites/restore")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse restore12WithHttpInfo(RestoreEntity restoreEntity);
}