Package step.plugins.timeseries

Class TimeSeriesService

java.lang.Object

step.framework.server.AbstractServices<User>

step.core.deployment.AbstractStepServices

step.plugins.timeseries.TimeSeriesService

@Singleton
@Path("/time-series")
public class TimeSeriesService
extends AbstractStepServices

Field Summary

Fields inherited from class step.core.deployment.AbstractStepServices

configuration, SESSION

Constructor Summary

Constructors

Constructor	Description
TimeSeriesService()

Method Summary

Modifier and Type	Method	Description
List<Measurement>	discoverMeasurements(String oqlFilter, int limit, int skip)
TimeSeriesAPIResponse	getBuckets(FetchBucketsRequest request)
Set<String>	getMeasurementsAttributes(String oqlFilter)
MeasurementsStats	getRawMeasurementsStats(String oqlFilter)
void	init()
AsyncTaskStatus<Object>	rebuildTimeSeries(TimeSeriesRebuildRequest request)
boolean	timeSeriesIsBuilt(String executionId)
OQLVerifyResponse	verifyOql(@NotNull String oql)	Return details about the provided OQL, like if it's valid or not, found attributes, etc

Methods inherited from class step.core.deployment.AbstractStepServices

checkRightsOnBehalfOf, getAuthorizationManager, getContext, getExecutionRunnable, getObjectEnricher, getObjectFilter, getScheduler

Methods inherited from class step.framework.server.AbstractServices

getAbstractContext, getHttpSession, getSession, getSession, invalidateSession, setHttpServletRequest, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TimeSeriesService

public TimeSeriesService()

Method Details

init

@PostConstruct
public void init()
          throws Exception

Overrides:

init in class AbstractStepServices

Throws:

Exception

getBuckets

@POST
@Path("/buckets")
@Consumes("application/json")
@Produces("application/json")
public TimeSeriesAPIResponse getBuckets(FetchBucketsRequest request)

verifyOql

@GET
@Path("/oql-verify")
@Consumes("application/json")
@Produces("application/json")
public OQLVerifyResponse verifyOql(@NotNull @QueryParam("oql")
 @NotNull String oql)

Return details about the provided OQL, like if it's valid or not, found attributes, etc

rebuildTimeSeries

@POST
@Path("/rebuild")
@Consumes("application/json")
@Produces("application/json")
public AsyncTaskStatus<Object> rebuildTimeSeries(TimeSeriesRebuildRequest request)

timeSeriesIsBuilt

@GET
@Path("/execution/{executionId}/exists")
@Consumes("application/json")
@Produces("application/json")
public boolean timeSeriesIsBuilt(@PathParam("executionId")
 String executionId)

getMeasurementsAttributes

@GET
@Path("/measurements-fields")
@Consumes("application/json")
@Produces("application/json")
public Set<String> getMeasurementsAttributes(@QueryParam("filter")
 String oqlFilter)

discoverMeasurements

@GET
@Path("/raw-measurements")
@Consumes("application/json")
@Produces("application/json")
public List<Measurement> discoverMeasurements(@QueryParam("filter")
 String oqlFilter,
 @QueryParam("limit")
 int limit,
 @QueryParam("skip")
 int skip)

getRawMeasurementsStats

@GET
@Path("/raw-measurements/stats")
@Consumes("application/json")
@Produces("application/json")
public MeasurementsStats getRawMeasurementsStats(@QueryParam("filter")
 String oqlFilter)