com.cloudera.api.model

Class ApiMetricSchema

java.lang.Object

com.cloudera.api.model.ApiMetricSchema

public class ApiMetricSchema
extends Object

A metric schema represents the schema for a specific metric monitored by the Cloudera Management Services.

Constructor Summary

Constructors

Constructor and Description
ApiMetricSchema()
ApiMetricSchema(String name, String displayName, String description, boolean isCounter, String unitNumerator, String unitDenominator, List<String> aliases, Map<String,List<String>> sources)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAliases() Aliases for the metric.
String	getDescription() Description of the metric.
String	getDisplayName() Display name of the metric.
boolean	getIsCounter() Is the metric a counter.
String	getName() Name of the metric.
Map<String,List<String>>	getSources() Sources for the metric.
String	getUnitDenominator() Denominator for the unit of the metric.
String	getUnitNumerator() Numerator for the unit of the metric.
void	setAliases(List<String> aliases)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setIsCounter(boolean isCounter)
void	setName(String name)
void	setSources(Map<String,List<String>> sources)
void	setUnitDenominator(String unitDenominator)
void	setUnitNumerator(String unitNumerator)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiMetricSchema

public ApiMetricSchema()

ApiMetricSchema

public ApiMetricSchema(String name,
               String displayName,
               String description,
               boolean isCounter,
               String unitNumerator,
               String unitDenominator,
               List<String> aliases,
               Map<String,List<String>> sources)

Method Detail

getName

public String getName()

Name of the metric. This name is guaranteed to be unique among the metrics.

setName

public void setName(String name)

getDisplayName

public String getDisplayName()

Display name of the metric.

setDisplayName

public void setDisplayName(String displayName)

getDescription

public String getDescription()

Description of the metric.

setDescription

public void setDescription(String description)

getIsCounter

public boolean getIsCounter()

Is the metric a counter. A counter tracks the total count since a process / host started. The rate of change of a counter may often be more interesting than the raw value of a counter.

setIsCounter

public void setIsCounter(boolean isCounter)

getUnitNumerator

public String getUnitNumerator()

Numerator for the unit of the metric.

setUnitNumerator

public void setUnitNumerator(String unitNumerator)

getUnitDenominator

public String getUnitDenominator()

Denominator for the unit of the metric.

setUnitDenominator

public void setUnitDenominator(String unitDenominator)

getAliases

public List<String> getAliases()

Aliases for the metric. An alias is unique per metric (per source and version) but is not globally unique. Aliases usually refer to previous names for the metric as metrics are renamed or replaced.

setAliases

public void setAliases(List<String> aliases)

getSources

public Map<String,List<String>> getSources()

Sources for the metric. Each source entry contains the name of the source and a list of versions for which this source is valid

setSources

public void setSources(Map<String,List<String>> sources)