com.cloudera.api.model

Class ApiTimeSeriesRequest

java.lang.Object

com.cloudera.api.model.ApiTimeSeriesRequest

public class ApiTimeSeriesRequest
extends Object

Request object containing information needed for querying timeseries data. Available since API v11.

Constructor Summary

Constructors

Constructor and Description
ApiTimeSeriesRequest()
ApiTimeSeriesRequest(String query, String from, String to)
ApiTimeSeriesRequest(String query, String from, String to, String contentType, String desiredRollup, Boolean mustUseDesiredRollup)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getContentType() contentType to return the response in.
String	getDesiredRollup() Aggregate rollup level desired for the response data.
String	getFrom() Start of the period to query in ISO 8601 format (defaults to 5 minutes before the end of the period).
Boolean	getMustUseDesiredRollup() If set to true, then the tsquery will return data with the desired aggregate rollup level.
String	getQuery() tsquery to run against the CM time-series data store.
String	getTo() End of the period to query in ISO 8601 format (defaults to current time).
int	hashCode()
void	setContentType(String contentType)
void	setDesiredRollup(String desiredRollup)
void	setFrom(String from)
void	setMustUseDesiredRollup(Boolean mustUseDesiredRollup)
void	setQuery(String query)
void	setTo(String to)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiTimeSeriesRequest

public ApiTimeSeriesRequest(String query,
                    String from,
                    String to)

ApiTimeSeriesRequest

public ApiTimeSeriesRequest(String query,
                    String from,
                    String to,
                    String contentType,
                    String desiredRollup,
                    Boolean mustUseDesiredRollup)

ApiTimeSeriesRequest

public ApiTimeSeriesRequest()

Method Detail

getQuery

public String getQuery()

tsquery to run against the CM time-series data store. Please see the tsquery language documentation.

setQuery

public void setQuery(String query)

getFrom

public String getFrom()

Start of the period to query in ISO 8601 format (defaults to 5 minutes before the end of the period).

setFrom

public void setFrom(String from)

getTo

public String getTo()

End of the period to query in ISO 8601 format (defaults to current time).

setTo

public void setTo(String to)

getContentType

public String getContentType()

contentType to return the response in. The content types "application/json" and "text/csv" are supported. This defaults to "application/json". If "text/csv" is specified then we return one row per time series data point, and we don't return any of the metadata.

setContentType

public void setContentType(String contentType)

getDesiredRollup

public String getDesiredRollup()

Aggregate rollup level desired for the response data. Valid values are RAW, TEN_MINUTELY, HOURLY, SIX_HOURLY, DAILY, and WEEKLY. Note that if the mustUseDesiredRollup parameter is not set, then the monitoring server can decide to return a different rollup level.

setDesiredRollup

public void setDesiredRollup(String desiredRollup)

getMustUseDesiredRollup

public Boolean getMustUseDesiredRollup()

If set to true, then the tsquery will return data with the desired aggregate rollup level.

setMustUseDesiredRollup

public void setMustUseDesiredRollup(Boolean mustUseDesiredRollup)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object