Package org.openmetadata.service.resources.reports

Class ReportResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Report,ReportRepository>

org.openmetadata.service.resources.reports.ReportResource

@Path("/v1/reports")
@Produces("application/json")
@Consumes("application/json")
public class ReportResource
extends EntityResource<Report,ReportRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReportResource.ReportList

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

Method Summary

Modifier and Type	Method	Description
Report	addHref(javax.ws.rs.core.UriInfo uriInfo, Report entity)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid Report report)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid Report report)
Report	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
ResultList<Report>	list(javax.ws.rs.core.UriInfo uriInfo, String fieldsParam)

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

addHref, addViewOperation, copy, 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

ReportResource

public ReportResource(CollectionDAO dao,
                      Authorizer authorizer)

Method Detail

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Report,ReportRepository>

addHref

public Report addHref(javax.ws.rs.core.UriInfo uriInfo,
                      Report entity)

Specified by:

addHref in class EntityResource<Report,ReportRepository>

list

@GET
public ResultList<Report> list(@Context
                               javax.ws.rs.core.UriInfo uriInfo,
                               @QueryParam("fields")
                               String fieldsParam)

get

@GET
@Path("/{id}")
public Report 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)
           throws IOException

Throws:

IOException

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 Report report)

Overrides:

create in class EntityResource<Report,ReportRepository>

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 Report report)

Overrides:

createOrUpdate in class EntityResource<Report,ReportRepository>