Package org.openmetadata.service.resources.dataInsight

Class DataInsightChartResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<DataInsightChart,DataInsightChartRepository>

org.openmetadata.service.resources.dataInsight.DataInsightChartResource

@Path("/v1/analytics/dataInsights/charts")
@Produces("application/json")
@Consumes("application/json")
public class DataInsightChartResource
extends EntityResource<DataInsightChart,DataInsightChartRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataInsightChartResource.DataInsightChartList
static class	DataInsightChartResource.DataInsightChartResultList

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
DataInsightChart	addHref(javax.ws.rs.core.UriInfo uriInfo, DataInsightChart entity)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDataInsightChart create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateDataInsightChart 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)
DataInsightChart	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
DataInsightChart	getByName(javax.ws.rs.core.UriInfo uriInfo, String fqn, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
DataInsightChart	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.
ResultList<DataInsightChart>	list(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, @javax.validation.constraints.Min(0L),@javax.validation.constraints.Max(1000000L) int limitParam, String before, String after, Include include)
javax.ws.rs.core.Response	listDataInsightChartResult(javax.ws.rs.core.SecurityContext securityContext, DataInsightChartResult.DataInsightChartType dataInsightChartName, @NonNull String dataReportIndex, String tier, String team, String organization, @NonNull Long startTs, @NonNull Long endTs)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	restoreDataInsightChart(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, getEntitySpecificOperations, 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

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

Constant Field Values

FIELDS

public static final String FIELDS

See Also:

Constant Field Values

Constructor Detail

DataInsightChartResource

public DataInsightChartResource(CollectionDAO dao,
                                Authorizer authorizer)

Method Detail

addHref

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

Specified by:

addHref in class EntityResource<DataInsightChart,DataInsightChartRepository>

initialize

public void initialize(OpenMetadataApplicationConfig config)
                throws IOException,
                       ClassNotFoundException,
                       NoSuchMethodException,
                       InvocationTargetException,
                       InstantiationException,
                       IllegalAccessException

Description copied from class: EntityResource

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

Overrides:

initialize in class EntityResource<DataInsightChart,DataInsightChartRepository>

Throws:

IOException

ClassNotFoundException

NoSuchMethodException

InvocationTargetException

InstantiationException

IllegalAccessException

list

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

restoreDataInsightChart

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

listDataInsightChartResult

@GET
@Path("/aggregate")
public javax.ws.rs.core.Response listDataInsightChartResult(@Context
                                                            javax.ws.rs.core.SecurityContext securityContext,
                                                            @NonNull @QueryParam("dataInsightChartName")
                                                            DataInsightChartResult.DataInsightChartType dataInsightChartName,
                                                            @NonNull @QueryParam("dataReportIndex")
                                                            @NonNull String dataReportIndex,
                                                            @QueryParam("tier")
                                                            String tier,
                                                            @QueryParam("team")
                                                            String team,
                                                            @QueryParam("organization")
                                                            String organization,
                                                            @NonNull @QueryParam("startTs")
                                                            @NonNull Long startTs,
                                                            @NonNull @QueryParam("endTs")
                                                            @NonNull Long endTs)
                                                     throws IOException,
                                                            ParseException

Throws:

IOException

ParseException