com.cloudera.api.model
Class ApiTimeSeriesEntityType

java.lang.Object
  com.cloudera.api.model.ApiTimeSeriesEntityType

public class ApiTimeSeriesEntityType
extends Object

Describe a time series entity type and attributes associated with this entity type.

Available since API v11.

Constructor Summary

ApiTimeSeriesEntityType()

Method Summary

String	getCategory() Returns the category of the entity type.
String	getDescription() Returns the description of the entity type.
String	getDisplayName() Returns the display name of the entity type.
String	getEntityDisplayNameFormat() Returns a format string that will be used to construct the display name of entities of this type.
List<String>	getEntityNameFormat() Returns a list of attribute names that will be used to construct entity names for entities of this type.
List<String>	getImmutableAttributeNames() Returns the list of immutable attributes for this entity type.
List<String>	getMutableAttributeNames() Returns the list of mutable attributes for this entity type.
String	getName() Returns the name of the entity type.
String	getNameForCrossEntityAggregateMetrics() Returns the string to use to pluralize the name of the entity for cross entity aggregate metrics.
List<String>	getParentMetricEntityTypeNames() Returns a list of metric entity type names which are parents of this metric entity type.
void	setCategory(String category)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setEntityDisplayNameFormat(String entityDisplayNameFormat)
void	setEntityNameFormat(List<String> value)
void	setImmutableAttributeNames(List<String> value)
void	setMutableAttributeNames(List<String> value)
void	setName(String name)
void	setNameForCrossEntityAggregateMetrics(String value)
void	setParentMetricEntityTypeNames(List<String> value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiTimeSeriesEntityType

public ApiTimeSeriesEntityType()

Method Detail

getName

public String getName()

Returns the name of the entity type. This name uniquely identifies this entity type.

setName

public void setName(String name)

getCategory

public String getCategory()

Returns the category of the entity type.

setCategory

public void setCategory(String category)

getNameForCrossEntityAggregateMetrics

public String getNameForCrossEntityAggregateMetrics()

Returns the string to use to pluralize the name of the entity for cross entity aggregate metrics.

setNameForCrossEntityAggregateMetrics

public void setNameForCrossEntityAggregateMetrics(String value)

getDisplayName

public String getDisplayName()

Returns the display name of the entity type.

setDisplayName

public void setDisplayName(String displayName)

getDescription

public String getDescription()

Returns the description of the entity type.

setDescription

public void setDescription(String description)

getImmutableAttributeNames

public List<String> getImmutableAttributeNames()

Returns the list of immutable attributes for this entity type. Immutable attributes values for an entity may not change over its lifetime.

setImmutableAttributeNames

public void setImmutableAttributeNames(List<String> value)

getMutableAttributeNames

public List<String> getMutableAttributeNames()

Returns the list of mutable attributes for this entity type. Mutable attributes for an entity may change over its lifetime.

setMutableAttributeNames

public void setMutableAttributeNames(List<String> value)

getEntityNameFormat

public List<String> getEntityNameFormat()

Returns a list of attribute names that will be used to construct entity names for entities of this type. The attributes named here must be immutable attributes of this type or a parent type.

setEntityNameFormat

public void setEntityNameFormat(List<String> value)

getEntityDisplayNameFormat

public String getEntityDisplayNameFormat()

Returns a format string that will be used to construct the display name of entities of this type. If this returns null the entity name would be used as the display name. The entity attribute values are used to replace $attribute name portions of this format string. For example, an entity with roleType "DATANODE" and hostname "foo.com" will have a display name "DATANODE (foo.com)" if the format is "$roleType ($hostname)".

setEntityDisplayNameFormat

public void setEntityDisplayNameFormat(String entityDisplayNameFormat)

getParentMetricEntityTypeNames

public List<String> getParentMetricEntityTypeNames()

Returns a list of metric entity type names which are parents of this metric entity type. A metric entity type inherits the attributes of its ancestors. For example a role metric entity type has its service as a parent. A service metric entity type has a cluster as a parent. The role type inherits its cluster name attribute through its service parent. Only parent ancestors should be returned here. In the example given, only the service metric entity type should be specified in the parent list.

setParentMetricEntityTypeNames

public void setParentMetricEntityTypeNames(List<String> value)