com.axibase.tsd.model.data.command
Class GetSeriesQuery

java.lang.Object
  com.axibase.tsd.model.data.command.GetSeriesQuery

public class GetSeriesQuery
extends Object

Author:

Nikolay Malevanny.

Constructor Summary

GetSeriesQuery(String entityName, String metricName)

GetSeriesQuery(String entityName, String metricName, Map<String,String> tags)

GetSeriesQuery(String entityName, String metricName, javax.ws.rs.core.MultivaluedMap<String,String> tags)

Method Summary

SimpleAggregateMatcher	getAggregateMatcher()
String	getEndDate()
Long	getEndTime()
String	getEntityName()
String	getInterval()
Join	getJoin()
Boolean	getLast()
Integer	getLimit()
String	getMetricName()
Rate	getRate()
String	getRequestId()
String	getStartDate()
Long	getStartTime()
javax.ws.rs.core.MultivaluedMap<String,String>	getTags()
SeriesType	getType()
void	setAggregateMatcher(SimpleAggregateMatcher aggregateMatcher)
void	setEndDate(String endDate)
void	setEndTime(Long endTime)
void	setInterval(String interval)
void	setJoin(Join join)
void	setLast(Boolean last)
void	setLimit(Integer limit)
void	setRate(Rate rate)
void	setRequestId(String requestId) To associate 'series' object (one) in request with 'series' objects (many) in response, the client can optionally specify a unique 'requestId' property in each series object in request.
void	setStartDate(String startDate)
void	setStartTime(Long startTime)
void	setTags(javax.ws.rs.core.MultivaluedMap<String,String> tags)
void	setType(SeriesType type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GetSeriesQuery

public GetSeriesQuery(String entityName,
                      String metricName)

Parameters:

entityName - an entity's name of the requested time series. User defined values (case insensitive).

metricName - a metric name of the requested time series. User defined values (case insensitive).

GetSeriesQuery

public GetSeriesQuery(String entityName,
                      String metricName,
                      javax.ws.rs.core.MultivaluedMap<String,String> tags)

Parameters:

entityName - an entity's name of the requested time series. User defined values (case insensitive).

metricName - a metric name of the requested time series. User defined values (case insensitive).

tags - Object key is a tag name and a value is an array of possible tag values

GetSeriesQuery

public GetSeriesQuery(String entityName,
                      String metricName,
                      Map<String,String> tags)

Parameters:

entityName - an entity's name of the requested time series. User defined values (case insensitive).

metricName - a metric name of the requested time series. User defined values (case insensitive).

tags - Object key is a tag name and a value is an array of possible tag values

Method Detail

getStartTime

public Long getStartTime()

getEndTime

public Long getEndTime()

getStartDate

public String getStartDate()

getEndDate

public String getEndDate()

getInterval

public String getInterval()

getLimit

public Integer getLimit()

getLast

public Boolean getLast()

getEntityName

public String getEntityName()

getMetricName

public String getMetricName()

getTags

public javax.ws.rs.core.MultivaluedMap<String,String> getTags()

getType

public SeriesType getType()

getJoin

public Join getJoin()

getRate

public Rate getRate()

getAggregateMatcher

public SimpleAggregateMatcher getAggregateMatcher()

getRequestId

public String getRequestId()

setStartTime

public void setStartTime(Long startTime)

Parameters:

startTime - start of the selection interval. Unix milliseconds.

setEndTime

public void setEndTime(Long endTime)

Parameters:

endTime - end of the selection interval. Unix milliseconds.

setStartDate

public void setStartDate(String startDate)

Parameters:

startDate - start of the selection interval. Specified in ISO format or using endtime syntax.

setEndDate

public void setEndDate(String endDate)

Parameters:

endDate - end of the selection interval. Specified in ISO format or using endtime syntax.

setInterval

public void setInterval(String interval)

Parameters:

interval - Duration of the selection interval, specified as count-timeunit, for example, 1-hour

setLimit

public void setLimit(Integer limit)

Parameters:

limit - maximum number of data samples returned.

setLast

public void setLast(Boolean last)

Parameters:

last - if true: Performs GET instead of scan. Retrieves only 1 most recent value.

setTags

public void setTags(javax.ws.rs.core.MultivaluedMap<String,String> tags)

Parameters:

tags - Object key is a tag name and a value is an array of possible tag values. User defined values ( keys: case insensitive, values: case sensitive )

setType

public void setType(SeriesType type)

Parameters:

type - specifies source for underlying data

setJoin

public void setJoin(Join join)

Parameters:

join - Merges multiple time series into one serie.

setRate

public void setRate(Rate rate)

Parameters:

rate - Computes difference between consecutive samples per unit of time (rate interval).

setAggregateMatcher

public void setAggregateMatcher(SimpleAggregateMatcher aggregateMatcher)

Parameters:

aggregateMatcher - Computes statistics for the specified time intervals.

setRequestId

public void setRequestId(String requestId)

To associate 'series' object (one) in request with 'series' objects (many) in response, the client can optionally specify a unique 'requestId' property in each series object in request. For example, the client can set requestId to series object's index in the request. The server echos requestId for each series in the response.

Parameters:

requestId - Optional identifier used to associate 'series' object in request with 'series' objects in response. Any string (case sensitive).

toString

public String toString()

Overrides:

toString in class Object