Package org.openmetadata.service.resources.dqtests

Class TestSuiteResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<TestSuite,TestSuiteRepository>

org.openmetadata.service.resources.dqtests.TestSuiteResource

@Path("/v1/dataQuality/testSuites")
@Produces("application/json")
@Consumes("application/json")
public class TestSuiteResource
extends EntityResource<TestSuite,TestSuiteRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestSuiteResource.TestSuiteList

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION_PATH
static String	EXECUTABLE_TEST_SUITE_DELETION_ERROR
static String	NON_EXECUTABLE_TEST_SUITE_DELETION_ERROR

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
TestSuiteResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
TestSuite	addHref(javax.ws.rs.core.UriInfo uriInfo, TestSuite testSuite)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTestSuite create)
javax.ws.rs.core.Response	createExecutable(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTestSuite create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTestSuite create)
javax.ws.rs.core.Response	createOrUpdateExecutable(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTestSuite create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String name)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, UUID id)
javax.ws.rs.core.Response	deleteExecutable(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean recursive, boolean hardDelete, String name)
javax.ws.rs.core.Response	deleteExecutable(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean recursive, boolean hardDelete, UUID id)
TestSuite	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
TestSuite	getByName(javax.ws.rs.core.UriInfo uriInfo, String name, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
TestSummary	getTestsExecutionSummary(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID testSuiteId)
TestSuite	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<TestSuite>	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 testSuiteType, String before, String after, Include include)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	restoreTestSuite(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid RestoreEntity restore)
javax.ws.rs.core.Response	updateDescription(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

EXECUTABLE_TEST_SUITE_DELETION_ERROR

public static final String EXECUTABLE_TEST_SUITE_DELETION_ERROR

See Also:

Constant Field Values

NON_EXECUTABLE_TEST_SUITE_DELETION_ERROR

public static final String NON_EXECUTABLE_TEST_SUITE_DELETION_ERROR

See Also:

Constant Field Values

Constructor Detail

TestSuiteResource

public TestSuiteResource(CollectionDAO dao,
                         Authorizer authorizer)

Method Detail

addHref

public TestSuite addHref(javax.ws.rs.core.UriInfo uriInfo,
                         TestSuite testSuite)

Specified by:

addHref in class EntityResource<TestSuite,TestSuiteRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<TestSuite,TestSuiteRepository>

list

@GET
public ResultList<TestSuite> 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("testSuiteType")
                                  String testSuiteType,
                                  @QueryParam("before")
                                  String before,
                                  @QueryParam("after")
                                  String after,
                                  @QueryParam("include") @DefaultValue("non-deleted")
                                  Include include)

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 TestSuite 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/{name}")
public TestSuite getByName(@Context
                           javax.ws.rs.core.UriInfo uriInfo,
                           @PathParam("name")
                           String name,
                           @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 TestSuite getVersion(@Context
                            javax.ws.rs.core.UriInfo uriInfo,
                            @Context
                            javax.ws.rs.core.SecurityContext securityContext,
                            @PathParam("id")
                            UUID id,
                            @PathParam("version")
                            String version)

getTestsExecutionSummary

@GET
@Path("/executionSummary")
public TestSummary getTestsExecutionSummary(@Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            @Context
                                            javax.ws.rs.core.SecurityContext securityContext,
                                            @QueryParam("testSuiteId")
                                            UUID testSuiteId)

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 CreateTestSuite create)

createExecutable

@POST
@Path("/executable")
public javax.ws.rs.core.Response createExecutable(@Context
                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                  @Context
                                                  javax.ws.rs.core.SecurityContext securityContext,
                                                  @Valid
                                                  @Valid CreateTestSuite create)

updateDescription

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response updateDescription(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @Context
                                                   javax.ws.rs.core.SecurityContext securityContext,
                                                   @PathParam("id")
                                                   UUID id,
                                                   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 CreateTestSuite create)

createOrUpdateExecutable

@PUT
@Path("/executable")
public javax.ws.rs.core.Response createOrUpdateExecutable(@Context
                                                          javax.ws.rs.core.UriInfo uriInfo,
                                                          @Context
                                                          javax.ws.rs.core.SecurityContext securityContext,
                                                          @Valid
                                                          @Valid CreateTestSuite 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,
                                        @PathParam("id")
                                        UUID id)

delete

@DELETE
@Path("/name/{name}")
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,
                                        @PathParam("name")
                                        String name)

deleteExecutable

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

deleteExecutable

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

restoreTestSuite

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