Package org.openmetadata.service.resources.topics

Class TopicResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Topic,TopicRepository>

org.openmetadata.service.resources.topics.TopicResource

@Path("/v1/topics")
@Produces("application/json")
@Consumes("application/json")
public class TopicResource
extends EntityResource<Topic,TopicRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TopicResource.TopicList

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

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, UUID userId)
Topic	addHref(javax.ws.rs.core.UriInfo uriInfo, Topic topic)
Topic	addSampleData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, @Valid TopicSampleData sampleData)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTopic create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateTopic create)
javax.ws.rs.core.Response	delete(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, boolean hardDelete, String fqn)
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	deleteFollower(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String userId)
Topic	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
Topic	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
Topic	getSampleData(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
Topic	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<Topic>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, String serviceParam, @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	restoreTopic(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

Constructor Detail

TopicResource

public TopicResource(CollectionDAO dao,
                     Authorizer authorizer)

Method Detail

addHref

public Topic addHref(javax.ws.rs.core.UriInfo uriInfo,
                     Topic topic)

Specified by:

addHref in class EntityResource<Topic,TopicRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Topic,TopicRepository>

list

@GET
public ResultList<Topic> list(@Context
                              javax.ws.rs.core.UriInfo uriInfo,
                              @Context
                              javax.ws.rs.core.SecurityContext securityContext,
                              @QueryParam("fields")
                              String fieldsParam,
                              @QueryParam("service")
                              String serviceParam,
                              @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("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 Topic 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 Topic 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 Topic 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 CreateTopic 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 CreateTopic create)

addSampleData

@PUT
@Path("/{id}/sampleData")
public Topic addSampleData(@Context
                           javax.ws.rs.core.UriInfo uriInfo,
                           @Context
                           javax.ws.rs.core.SecurityContext securityContext,
                           @PathParam("id")
                           UUID id,
                           @Valid
                           @Valid TopicSampleData sampleData)

getSampleData

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

addFollower

@PUT
@Path("/{id}/followers")
public javax.ws.rs.core.Response addFollower(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             @Context
                                             javax.ws.rs.core.SecurityContext securityContext,
                                             @PathParam("id")
                                             UUID id,
                                             UUID userId)

deleteFollower

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

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/{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)

restoreTopic

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