Package org.openmetadata.service.resources.kpi

Class KpiResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Kpi,KpiRepository>

org.openmetadata.service.resources.kpi.KpiResource

@Path("/v1/kpi")
@Produces("application/json")
@Consumes("application/json")
public class KpiResource
extends EntityResource<Kpi,KpiRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KpiResource.KpiList
static class	KpiResource.KpiResultList

Field Summary

Fields

Modifier and Type	Field	Description
static final 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
KpiResource(Authorizer authorizer)

Method Summary

Modifier and Type	Method	Description
Kpi	addHref(javax.ws.rs.core.UriInfo uriInfo, Kpi kpi)
javax.ws.rs.core.Response	addKpiResult(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, @Valid KpiResult kpiResult)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateKpiRequest create)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid CreateKpiRequest 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 name)
javax.ws.rs.core.Response	deleteKpiResult(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, String name, Long timestamp)
Kpi	get(javax.ws.rs.core.UriInfo uriInfo, UUID id, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
Kpi	getByName(javax.ws.rs.core.UriInfo uriInfo, String name, javax.ws.rs.core.SecurityContext securityContext, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
Kpi	getVersion(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String version)
ResultList<Kpi>	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)
KpiResult	listKpiResults(javax.ws.rs.core.SecurityContext securityContext, String name)
ResultList<KpiResult>	listKpiResults(javax.ws.rs.core.SecurityContext securityContext, String name, @NonNull Long startTs, @NonNull Long endTs, @Valid EntityTimeSeriesDAO.OrderBy orderBy)
EntityHistory	listVersions(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id)
javax.ws.rs.core.Response	patchKpi(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, javax.json.JsonPatch patch)
javax.ws.rs.core.Response	restoreKpi(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, 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 Details

COLLECTION_PATH

public static final String COLLECTION_PATH

See Also:

• Constant Field Values

Constructor Details

KpiResource

public KpiResource(Authorizer authorizer)

Method Details

addHref

public Kpi addHref(javax.ws.rs.core.UriInfo uriInfo,
 Kpi kpi)

Overrides:

addHref in class EntityResource<Kpi,KpiRepository>

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Kpi,KpiRepository>

list

@GET
public ResultList<Kpi> 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 Kpi 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/{name}")
public Kpi getByName(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @PathParam("name")
 String name,
 @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 Kpi 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 CreateKpiRequest create)

patchKpi

@PATCH
@Path("/{id}")
@Consumes("application/json-patch+json")
public javax.ws.rs.core.Response patchKpi(@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 CreateKpiRequest create)

delete

@DELETE
@Path("/name/{name}")
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("name")
 String name)

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)

restoreKpi

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

addKpiResult

@PUT
@Path("/{name}/kpiResult")
public javax.ws.rs.core.Response addKpiResult(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name,
 @Valid
 @Valid KpiResult kpiResult)

listKpiResults

@GET
@Path("/{name}/kpiResult")
public ResultList<KpiResult> listKpiResults(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name,
 @NonNull @QueryParam("startTs")
 @NonNull Long startTs,
 @NonNull @QueryParam("endTs")
 @NonNull Long endTs,
 @Valid @QueryParam("orderBy") @DefaultValue("DESC")
 @Valid EntityTimeSeriesDAO.OrderBy orderBy)

listKpiResults

@GET
@Path("/{name}/latestKpiResult")
public KpiResult listKpiResults(@Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name)

deleteKpiResult

@DELETE
@Path("/{name}/kpiResult/{timestamp}")
public javax.ws.rs.core.Response deleteKpiResult(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.SecurityContext securityContext,
 @PathParam("name")
 String name,
 @PathParam("timestamp")
 Long timestamp)