Package org.openmetadata.service.resources.dashboards

Class DashboardResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Dashboard,DashboardRepository>

org.openmetadata.service.resources.dashboards.DashboardResource

@Path("/v1/dashboards")
@Produces("application/json")
@Consumes("application/json")
public class DashboardResource
extends EntityResource<Dashboard,DashboardRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DashboardResource.DashboardList

Field Summary

Fields

Modifier and Type	Field	Description
static String	COLLECTION_PATH
protected static String	FIELDS

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
DashboardResource(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)
Dashboard	addHref(javax.ws.rs.core.UriInfo uriInfo, Dashboard dashboard)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDashboard create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDashboard 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, UUID userId)
Dashboard	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
Dashboard	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
Dashboard	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
@Valid ResultList<Dashboard>	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	restoreDashboard(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

FIELDS

protected static final String FIELDS

See Also:

Constant Field Values

Constructor Detail

DashboardResource

public DashboardResource(CollectionDAO dao,
                         Authorizer authorizer)

Method Detail

addHref

public Dashboard addHref(javax.ws.rs.core.UriInfo uriInfo,
                         Dashboard dashboard)

Specified by:

addHref in class EntityResource<Dashboard,DashboardRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Dashboard,DashboardRepository>

list

@GET
@Valid
public @Valid ResultList<Dashboard> 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") @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)

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 Dashboard 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 Dashboard 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 Dashboard 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 CreateDashboard 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 CreateDashboard create)

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")
                                                UUID 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)

restoreDashboard

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