com.cloudera.api.model
Class ApiMetric

java.lang.Object
  extended by com.cloudera.api.model.ApiMetric

public class ApiMetric
extends Object

A metric represents a specific metric monitored by the Cloudera Management Services, and a list of values matching a user query.

These fields are available only in the "full" view:


Constructor Summary
ApiMetric()
           
ApiMetric(String name, String context, String unit, List<ApiMetricData> data, String displayName, String description)
           
 
Method Summary
 String getContext()
          Context the metric is associated with.
 List<ApiMetricData> getData()
          List of readings retrieved from the monitors.
 String getDescription()
          Requires "full" view.
 String getDisplayName()
          Requires "full" view.
 String getName()
          Name of the metric.
 String getUnit()
          Unit of the metric values.
 void setContext(String context)
           
 void setData(List<ApiMetricData> data)
           
 void setDescription(String description)
           
 void setDisplayName(String displayName)
           
 void setName(String name)
           
 void setUnit(String unit)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ApiMetric

public ApiMetric()

ApiMetric

public ApiMetric(String name,
                 String context,
                 String unit,
                 List<ApiMetricData> data,
                 String displayName,
                 String description)
Method Detail

getName

public String getName()
Name of the metric.


setName

public void setName(String name)

getContext

public String getContext()
Context the metric is associated with.


setContext

public void setContext(String context)

getUnit

public String getUnit()
Unit of the metric values.


setUnit

public void setUnit(String unit)

getData

public List<ApiMetricData> getData()
List of readings retrieved from the monitors.


setData

public void setData(List<ApiMetricData> data)

getDisplayName

public String getDisplayName()
Requires "full" view. User-friendly display name for the metric.


setDisplayName

public void setDisplayName(String displayName)

getDescription

public String getDescription()
Requires "full" view. Description of the metric.


setDescription

public void setDescription(String description)


Copyright © Cloudera, Inc. Released under Apache License, Version 2.0.