Package org.openmetadata.service.resources.glossary

Class GlossaryTermResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<GlossaryTerm,GlossaryTermRepository>

org.openmetadata.service.resources.glossary.GlossaryTermResource

@Path("/v1/glossaryTerms")
@Produces("application/json")
@Consumes("application/json")
public class GlossaryTermResource
extends EntityResource<GlossaryTerm,GlossaryTermRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlossaryTermResource.GlossaryTermList

Field Summary

Fields

Modifier and Type	Field	Description
static 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
GlossaryTermResource(CollectionDAO dao, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
GlossaryTerm	addHref(javax.ws.rs.core.UriInfo uriInfo, GlossaryTerm term)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateGlossaryTerm create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateGlossaryTerm 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 fqn)
GlossaryTerm	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
GlossaryTerm	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
GlossaryTerm	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
@Valid ResultList<GlossaryTerm>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String glossaryIdParam, UUID parentTermParam, String fieldsParam, @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	restoreTable(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

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

Constructor Detail

GlossaryTermResource

public GlossaryTermResource(CollectionDAO dao,
                            Authorizer authorizer)

Method Detail

addHref

public GlossaryTerm addHref(javax.ws.rs.core.UriInfo uriInfo,
                            GlossaryTerm term)

Specified by:

addHref in class EntityResource<GlossaryTerm,GlossaryTermRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<GlossaryTerm,GlossaryTermRepository>

list

@GET
@Valid
public @Valid ResultList<GlossaryTerm> list(@Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            @Context
                                            javax.ws.rs.core.SecurityContext securityContext,
                                            @QueryParam("glossary")
                                            String glossaryIdParam,
                                            @QueryParam("parent")
                                            UUID parentTermParam,
                                            @QueryParam("fields")
                                            String fieldsParam,
                                            @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 GlossaryTerm 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/{fqn}")
public GlossaryTerm 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)

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 GlossaryTerm 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 CreateGlossaryTerm 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)

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 CreateGlossaryTerm 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,
                                        @DefaultValue("false") @QueryParam("recursive")
                                        boolean recursive,
                                        @QueryParam("hardDelete") @DefaultValue("false")
                                        boolean hardDelete,
                                        @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,
                                        @PathParam("fqn")
                                        String fqn)

restoreTable

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