Package org.openmetadata.service.resources.metrics

Class MetricsResource

java.lang.Object

org.openmetadata.service.resources.EntityResource<Metrics,MetricsRepository>

org.openmetadata.service.resources.metrics.MetricsResource

@Path("/v1/metrics")
@Produces("application/json")
@Consumes("application/json")
public class MetricsResource
extends EntityResource<Metrics,MetricsRepository>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricsResource.MetricsList

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

Method Summary

Modifier and Type	Method	Description
Metrics	addHref(javax.ws.rs.core.UriInfo uriInfo, Metrics entity)
javax.ws.rs.core.Response	create(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid Metrics metrics)
javax.ws.rs.core.Response	createOrUpdate(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, @Valid Metrics metrics)
Metrics	get(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.SecurityContext securityContext, UUID id, String fieldsParam, Include include)
protected List<MetadataOperation>	getEntitySpecificOperations()
ResultList<Metrics>	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)

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

MetricsResource

public MetricsResource(CollectionDAO dao,
                       Authorizer authorizer)

Method Detail

getEntitySpecificOperations

protected List<MetadataOperation> getEntitySpecificOperations()

Overrides:

getEntitySpecificOperations in class EntityResource<Metrics,MetricsRepository>

addHref

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

Specified by:

addHref in class EntityResource<Metrics,MetricsRepository>

list

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

get

@GET
@Path("/{id}")
public Metrics 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 Metrics metrics)

Overrides:

create in class EntityResource<Metrics,MetricsRepository>

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 Metrics metrics)

Overrides:

createOrUpdate in class EntityResource<Metrics,MetricsRepository>