Package org.openmetadata.service.resources.dqtests

Class TestCaseResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<TestCase,TestCaseRepository>

org.openmetadata.service.resources.dqtests.TestCaseResource

@Path("/v1/dataQuality/testCases")
@Produces("application/json")
@Consumes("application/json")
public class TestCaseResource
extends EntityResource<TestCase,TestCaseRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestCaseResource.TestCaseList
static class	TestCaseResource.TestCaseResultList

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLECTION_PATH

Fields inherited from class org.openmetadata.service.resources.EntityResource

allowedFields, authorizer, entityClass, entityType, fieldsToViewOperations, repository, VIEW_ALL_OPERATIONS, VIEW_BASIC_OPERATIONS

Constructor Summary

Constructors

Constructor	Description
TestCaseResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
TestCase	addFailedRowsData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid TableData tableData)
TestCase	addHref(javax.ws.rs.core.UriInfo uriInfo, TestCase test)
TestCase	addInspectionQuery(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid String query)
javax.ws.rs.core.Response	addTestCaseResult(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, @Valid TestCaseResult testCaseResult)
javax.ws.rs.core.Response	addTestCasesToLogicalTestSuite(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateLogicalTestCases createLogicalTestCases)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTestCase create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTestCase create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, boolean recursive, String fqn)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, boolean recursive, UUID id)
javax.ws.rs.core.Response	deleteFailedRowsData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	deleteLogicalTestCase(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID testSuiteId, UUID id)
javax.ws.rs.core.Response	deleteTestCaseResult(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, Long timestamp)
TestCase	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
TestCase	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
TableData	getFailedRowsData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
TestCase	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<TestCase>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, String entityLink, String testSuiteId, Boolean includeAllTests, Include include, String status, String type)
ResultList<TestCase>	listFromSearch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limit, @javax.validation.constraints.Min(0L) int offset, String entityLink, String testSuiteId, Boolean includeAllTests, Include include, String status, String type, String testPlatforms, Long startTimestamp, Long endTimestamp, String sortField, String sortNestedPath, String sortNestedMode, String sortType, String includeFields, String domain, String owner, String tags, String tier, String serviceName, String q)
ResultList<TestCaseResult>	listTestCaseResults(javax.ws.rs.core.SecurityContext securityContext, String fqn, @NonNull Long startTs, @NonNull Long endTs)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	patch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	patchTestCaseResult(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fqn, Long timestamp, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restoreTestCase(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)

Methods inherited from class org.openmetadata.service.resources.EntityResource

addHref, addViewOperation, create, createOrUpdate, delete, deleteByName, exportCsvInternal, getByNameInternal, getByNameInternal, getEntityReference, getEntityReferences, getFields, getInternal, getInternal, getResourceContext, getResourceContextById, getResourceContextByName, getVersionInternal, getVersionInternal, importCsvInternal, initialize, listInternal, listInternal, listInternalFromSearch, listVersionsInternal, listVersionsInternal, patchInternal, patchInternal, restoreEntity, upgrade

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

• Constant Field Values

Constructor Details

TestCaseResource

public TestCaseResource(Authorizer authorizer)

Method Details

addHref

public TestCase addHref(javax.ws.rs.core.UriInfo uriInfo,
 TestCase test)

Overrides:

addHref in class EntityResource<TestCase,TestCaseRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<TestCase,TestCaseRepository>

list

@GET
public ResultList<TestCase> list(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @DefaultValue("10") @QueryParam("limit") @Min(0L) @Max(1000000L)
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
 @QueryParam("before")
 String before,
 @QueryParam("after")
 String after,
 @QueryParam("entityLink")
 String entityLink,
 @QueryParam("testSuiteId")
 String testSuiteId,
 @QueryParam("includeAllTests") @DefaultValue("false")
 Boolean includeAllTests,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include,
 @QueryParam("testCaseStatus")
 String status,
 @QueryParam("testCaseType") @DefaultValue("all")
 String type)

listFromSearch

@GET
@Path("/search/list")
public ResultList<TestCase> listFromSearch(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @DefaultValue("10") @QueryParam("limit") @Min(0L) @Max(1000000L)
 @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limit,
 @QueryParam("offset") @DefaultValue("0") @Min(0L)
 @javax.validation.constraints.Min(0L) int offset,
 @QueryParam("entityLink")
 String entityLink,
 @QueryParam("testSuiteId")
 String testSuiteId,
 @QueryParam("includeAllTests") @DefaultValue("false")
 Boolean includeAllTests,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include,
 @QueryParam("testCaseStatus")
 String status,
 @QueryParam("testCaseType") @DefaultValue("all")
 String type,
 @QueryParam("testPlatforms")
 String testPlatforms,
 @QueryParam("startTimestamp")
 Long startTimestamp,
 @QueryParam("endTimestamp")
 Long endTimestamp,
 @QueryParam("sortField")
 String sortField,
 @QueryParam("sortNestedPath")
 String sortNestedPath,
 @QueryParam("sortNestedMode")
 String sortNestedMode,
 @QueryParam("sortType") @DefaultValue("desc")
 String sortType,
 @QueryParam("includeFields")
 String includeFields,
 @QueryParam("domain")
 String domain,
 @QueryParam("owner")
 String owner,
 @QueryParam("tags")
 String tags,
 @QueryParam("tier")
 String tier,
 @QueryParam("serviceName")
 String serviceName,
 @QueryParam("q")
 String q)
                                    throws IOException

Throws:

IOException

listVersions

@GET
@Path("/{id}/versions")
public EntityHistory listVersions(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

get

@GET
@Path("/{id}")
public TestCase get(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("id")
 UUID id,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

getByName

@GET
@Path("/name/{fqn}")
public TestCase getByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("fqn")
 String fqn,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("fields")
 String fieldsParam,
 @QueryParam("include") @DefaultValue("non-deleted")
 Include include)

getVersion

@GET
@Path("/{id}/versions/{version}")
public TestCase getVersion(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @PathParam("version")
 String version)

create

@POST
public javax.ws.rs.core.Response create(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateTestCase create)

patch

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patch(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 javax.json.JsonPatch patch)

patchTestCaseResult

@PATCH
@Path("/{fqn}/testCaseResult/{timestamp}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patchTestCaseResult(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fqn")
 String fqn,
 @PathParam("timestamp")
 Long timestamp,
 javax.json.JsonPatch patch)

createOrUpdate

@PUT
public javax.ws.rs.core.Response createOrUpdate(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateTestCase create)

delete

@DELETE
@Path("/{id}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @DefaultValue("false") @QueryParam("recursive")
 boolean recursive,
 @PathParam("id")
 UUID id)

delete

@DELETE
@Path("/name/{fqn}")
public javax.ws.rs.core.Response delete(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @QueryParam("hardDelete") @DefaultValue("false")
 boolean hardDelete,
 @DefaultValue("false") @QueryParam("recursive")
 boolean recursive,
 @PathParam("fqn")
 String fqn)

deleteLogicalTestCase

@DELETE
@Path("/logicalTestCases/{testSuiteId}/{id}")
public javax.ws.rs.core.Response deleteLogicalTestCase(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("testSuiteId")
 UUID testSuiteId,
 @PathParam("id")
 UUID id)

restoreTestCase

@PUT
@Path("/restore")
public javax.ws.rs.core.Response restoreTestCase(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid RestoreEntity restore)

addTestCaseResult

@PUT
@Path("/{fqn}/testCaseResult")
public javax.ws.rs.core.Response addTestCaseResult(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fqn")
 String fqn,
 @Valid
 @Valid TestCaseResult testCaseResult)

listTestCaseResults

@GET
@Path("/{fqn}/testCaseResult")
public ResultList<TestCaseResult> listTestCaseResults(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fqn")
 String fqn,
 @NonNull @QueryParam("startTs")
 @NonNull Long startTs,
 @NonNull @QueryParam("endTs")
 @NonNull Long endTs)

deleteTestCaseResult

@DELETE
@Path("/{fqn}/testCaseResult/{timestamp}")
public javax.ws.rs.core.Response deleteTestCaseResult(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("fqn")
 String fqn,
 @PathParam("timestamp")
 Long timestamp)

addFailedRowsData

@PUT
@Path("/{id}/failedRowsSample")
public TestCase addFailedRowsData(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @Valid
 @Valid TableData tableData)

addInspectionQuery

@PUT
@Path("/{id}/inspectionQuery")
public TestCase addInspectionQuery(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id,
 @Valid
 @Valid String query)

getFailedRowsData

@GET
@Path("/{id}/failedRowsSample")
public TableData getFailedRowsData(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

deleteFailedRowsData

@DELETE
@Path("/{id}/failedRowsSample")
public javax.ws.rs.core.Response deleteFailedRowsData(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("id")
 UUID id)

addTestCasesToLogicalTestSuite

@PUT
@Path("/logicalTestCases")
public javax.ws.rs.core.Response addTestCasesToLogicalTestSuite(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @Valid
 @Valid CreateLogicalTestCases createLogicalTestCases)