com.cloudera.api.model

Class ApiTimeSeriesMetadata

java.lang.Object

com.cloudera.api.model.ApiTimeSeriesMetadata

public class ApiTimeSeriesMetadata
extends Object

Metadata for a time series.

Constructor Summary

Constructors

Constructor and Description
ApiTimeSeriesMetadata()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlias() The alias for this stream's metric.
Map<String,String>	getAttributes() The attributes for the time series.
Date	getEndTime() The end time for the time series.
String	getEntityName() The display name for the entity associated with this time series.
String	getExpression() The tsquery expression that could be used to extract just this stream.
Long	getMetricCollectionFrequencyMs() The minimum frequency at which the underlying metric for this stream is collected.
String	getMetricName() The metric name for the time series.
String	getRollupUsed() The aggregate rollup for the returned data.
Date	getStartTime() The start time for the time series.
List<String>	getUnitDenominators() The denominators of the units for the time series.
List<String>	getUnitNumerators() The numerators of the units for the time series.
void	setAlias(String alias)
void	setAttributes(Map<String,String> attributes)
void	setEndTime(Date endTime)
void	setEntityName(String entityName)
void	setExpression(String expression)
void	setMetricCollectionFrequencyMs(Long metricCollectionFrequencyMs)
void	setMetricName(String metricName)
void	setRollupUsed(String rollupUsed)
void	setStartTime(Date startTime)
void	setUnitDenominators(List<String> unitDenominators)
void	setUnitNumerators(List<String> unitNumerators)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiTimeSeriesMetadata

public ApiTimeSeriesMetadata()

Method Detail

getMetricName

public String getMetricName()

The metric name for the time series.

setMetricName

public void setMetricName(String metricName)

getEntityName

public String getEntityName()

The display name for the entity associated with this time series. For example, if this was a time series for an HDFS service the entity name might be something like "My HDFS Service". If it was for a host it might be something like "myhost.mysite.com".

setEntityName

public void setEntityName(String entityName)

getStartTime

public Date getStartTime()

The start time for the time series.

setStartTime

public void setStartTime(Date startTime)

getEndTime

public Date getEndTime()

The end time for the time series.

setEndTime

public void setEndTime(Date endTime)

getAttributes

public Map<String,String> getAttributes()

The attributes for the time series. Note that the entityName entry in this map is not the same as the entityName field in this ApiTimeSeriesMetadata. The entityName entry in this map is a unique identifier for the entity and not the name displayed in the UI. For example, if this was a time series for the YARN Job History Server the entityName entry in this map might be something like "yarn-JOBHISTORY-6bd17ceb1489aae93fef4c867350d0dd"

setAttributes

public void setAttributes(Map<String,String> attributes)

getUnitNumerators

public List<String> getUnitNumerators()

The numerators of the units for the time series.

setUnitNumerators

public void setUnitNumerators(List<String> unitNumerators)

getUnitDenominators

public List<String> getUnitDenominators()

The denominators of the units for the time series.

setUnitDenominators

public void setUnitDenominators(List<String> unitDenominators)

getExpression

public String getExpression()

The tsquery expression that could be used to extract just this stream.

setExpression

public void setExpression(String expression)

getAlias

public String getAlias()

The alias for this stream's metric. Aliases correspond to use of the 'as' keyword in the tsquery.

setAlias

public void setAlias(String alias)

getMetricCollectionFrequencyMs

public Long getMetricCollectionFrequencyMs()

The minimum frequency at which the underlying metric for this stream is collected. Note that this can be null if the stream returns irregularly sampled data.

setMetricCollectionFrequencyMs

public void setMetricCollectionFrequencyMs(Long metricCollectionFrequencyMs)

getRollupUsed

public String getRollupUsed()

The aggregate rollup for the returned data. This can be TEN_MINUTELY, HOURLY, SIX_HOURLY, DAILY, or WEEKLY.

setRollupUsed

public void setRollupUsed(String rollupUsed)