Package org.openmetadata.service.resources.tags

Class ClassificationResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Classification,ClassificationRepository>

org.openmetadata.service.resources.tags.ClassificationResource

@Path("/v1/classifications")
@Produces("application/json")
@Consumes("application/json")
public class ClassificationResource
extends EntityResource<Classification,ClassificationRepository>

Field Summary

Fields

Modifier and Type	Field	Description
static String	TAG_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
ClassificationResource(CollectionDAO collectionDAO, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
Classification	addHref(javax.ws.rs.core.UriInfo uriInfo, Classification category)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateClassification create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateClassification create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean recursive, boolean hardDelete, UUID id)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String name)
Classification	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
Classification	getByName(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, String fieldsParam, Include include)
static Classification	getClassification(CreateClassification create, String updatedBy)
static Classification	getClassification(CreateClassification create, javax.ws.rs.core.SecurityContext securityContext)
protected List<MetadataOperation>	getEntitySpecificOperations()
Classification	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<Classification>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String disabled, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, 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	patch(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restore(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, 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

TAG_COLLECTION_PATH

public static final String TAG_COLLECTION_PATH

See Also:

Constant Field Values

Constructor Detail

ClassificationResource

public ClassificationResource(CollectionDAO collectionDAO,
                              Authorizer authorizer)

Method Detail

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Classification,ClassificationRepository>

list

@GET
public ResultList<Classification> list(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       @Context
                                       javax.ws.rs.core.SecurityContext securityContext,
                                       @QueryParam("fields")
                                       String fieldsParam,
                                       @QueryParam("disabled")
                                       String disabled,
                                       @DefaultValue("10") @Min(0L) @Max(1000000L) @QueryParam("limit")
                                       @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam,
                                       @QueryParam("before")
                                       String before,
                                       @QueryParam("after")
                                       String after,
                                       @QueryParam("include") @DefaultValue("non-deleted")
                                       Include include)

get

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

getByName

@GET
@Path("name/{name}")
public Classification getByName(@Context
                                javax.ws.rs.core.UriInfo uriInfo,
                                @Context
                                javax.ws.rs.core.SecurityContext securityContext,
                                @PathParam("name")
                                String name,
                                @QueryParam("fields")
                                String fieldsParam,
                                @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)

getVersion

@GET
@Path("/{id}/versions/{version}")
public Classification 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 CreateClassification create)

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 CreateClassification 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)

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,
                                        @DefaultValue("false") @QueryParam("recursive")
                                        boolean recursive,
                                        @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)

restore

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

addHref

public Classification addHref(javax.ws.rs.core.UriInfo uriInfo,
                              Classification category)

Specified by:

addHref in class EntityResource<Classification,ClassificationRepository>

getClassification

public static Classification getClassification(CreateClassification create,
                                               javax.ws.rs.core.SecurityContext securityContext)

getClassification

public static Classification getClassification(CreateClassification create,
                                               String updatedBy)