Package org.openmetadata.service.resources.tags

Class TagResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Tag,TagRepository>

org.openmetadata.service.resources.tags.TagResource

@Path("/v1/tags")
@Produces("application/json")
@Consumes("application/json")
public class TagResource
extends EntityResource<Tag,TagRepository>

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
TagResource(CollectionDAO collectionDAO, Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
Tag	addHref(javax.ws.rs.core.UriInfo uriInfo, Tag tag)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTag create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTag 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)
Tag	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
Tag	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
Tag	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
void	initialize(OpenMetadataApplicationConfig config)	Method used for initializing a resource, such as creating default policies, roles, etc.
@Valid ResultList<Tag>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String parent, String fieldsParam, Boolean 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, 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

TagResource

public TagResource(CollectionDAO collectionDAO,
                   Authorizer authorizer)

Method Detail

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Tag,TagRepository>

initialize

public void initialize(OpenMetadataApplicationConfig config)
                throws IOException

Description copied from class: EntityResource

Method used for initializing a resource, such as creating default policies, roles, etc.

Overrides:

initialize in class EntityResource<Tag,TagRepository>

Throws:

IOException

list

@GET
@Valid
public @Valid ResultList<Tag> list(@Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   javax.ws.rs.core.SecurityContext securityContext,
                                   @QueryParam("parent")
                                   String parent,
                                   @QueryParam("fields")
                                   String fieldsParam,
                                   @QueryParam("disabled") @DefaultValue("false")
                                   Boolean 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 Tag 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 Tag 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 Tag 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 CreateTag 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 CreateTag 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)

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 Tag addHref(javax.ws.rs.core.UriInfo uriInfo,
                   Tag tag)

Specified by:

addHref in class EntityResource<Tag,TagRepository>