MetricDescriptor (RHQ Client API 4.8.0 API)

java.lang.Object
- org.rhq.core.clientapi.descriptor.plugin.MetricDescriptor

public class MetricDescriptor
extends Object

A declared value that can be monitored for changes over time. Metrics are divided into several main types including numeric, string traits, timings and complex.

Java class for metric element declaration.

The following schema fragment specifies the expected content contained within this class.

 <element name="metric">
   <complexType>
     <complexContent>
       <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
         <sequence>
           <element ref="{urn:xmlns:rhq-plugin}version" minOccurs="0"/>
         </sequence>
         <attribute name="category" default="performance">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <enumeration value="availability"/>
               <enumeration value="performance"/>
               <enumeration value="throughput"/>
               <enumeration value="utilization"/>
             </restriction>
           </simpleType>
         </attribute>
         <attribute name="dataType" default="measurement">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <enumeration value="measurement"/>
               <enumeration value="trait"/>
               <enumeration value="calltime"/>
             </restriction>
           </simpleType>
         </attribute>
         <attribute name="defaultInterval">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}unsignedLong">
               <minInclusive value="30000"/>
             </restriction>
           </simpleType>
         </attribute>
         <attribute name="defaultOn" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
         <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
         <attribute name="destinationType">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <whiteSpace value="collapse"/>
               <minLength value="1"/>
               <maxLength value="100"/>
             </restriction>
           </simpleType>
         </attribute>
         <attribute name="displayName" type="{http://www.w3.org/2001/XMLSchema}string" />
         <attribute name="displayType" default="detail">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <enumeration value="summary"/>
               <enumeration value="detail"/>
             </restriction>
           </simpleType>
         </attribute>
         <attribute name="measurementType" default="dynamic">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <enumeration value="dynamic"/>
               <enumeration value="trendsup"/>
               <enumeration value="trendsdown"/>
             </restriction>
           </simpleType>
         </attribute>
         <attribute name="property" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
         <attribute name="units" type="{urn:xmlns:rhq-configuration}measurementUnitsDescriptor" default="none" />
       </restriction>
     </complexContent>
   </complexType>
 </element>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`category`
`protected String`	`dataType`
`protected BigInteger`	`defaultInterval`
`protected Boolean`	`defaultOn`
`protected String`	`description`
`protected String`	`destinationType`
`protected String`	`displayName`
`protected String`	`displayType`
`protected String`	`measurementType`
`protected String`	`property`
`protected MeasurementUnitsDescriptor`	`units`
`protected Version`	`version`

Constructor Summary

Constructors
Constructor and Description

MetricDescriptor()

Constructors
Constructor and Description
`MetricDescriptor()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getCategory()` Gets the value of the category property.
`String`	`getDataType()` Gets the value of the dataType property.
`BigInteger`	`getDefaultInterval()` Gets the value of the defaultInterval property.
`String`	`getDescription()` Gets the value of the description property.
`String`	`getDestinationType()` Gets the value of the destinationType property.
`String`	`getDisplayName()` Gets the value of the displayName property.
`String`	`getDisplayType()` Gets the value of the displayType property.
`String`	`getMeasurementType()` Gets the value of the measurementType property.
`String`	`getProperty()` Gets the value of the property property.
`MeasurementUnitsDescriptor`	`getUnits()` Gets the value of the units property.
`Version`	`getVersion()` Gets the value of the version property.
`boolean`	`isDefaultOn()` Gets the value of the defaultOn property.
`void`	`setCategory(String value)` Sets the value of the category property.
`void`	`setDataType(String value)` Sets the value of the dataType property.
`void`	`setDefaultInterval(BigInteger value)` Sets the value of the defaultInterval property.
`void`	`setDefaultOn(Boolean value)` Sets the value of the defaultOn property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setDestinationType(String value)` Sets the value of the destinationType property.
`void`	`setDisplayName(String value)` Sets the value of the displayName property.
`void`	`setDisplayType(String value)` Sets the value of the displayType property.
`void`	`setMeasurementType(String value)` Sets the value of the measurementType property.
`void`	`setProperty(String value)` Sets the value of the property property.
`void`	`setUnits(MeasurementUnitsDescriptor value)` Sets the value of the units property.
`void`	`setVersion(Version value)` Sets the value of the version property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
protected Version version
```
  - category
```
protected String category
```
  - dataType
```
protected String dataType
```
  - defaultInterval
```
protected BigInteger defaultInterval
```
  - defaultOn
```
protected Boolean defaultOn
```
  - description
```
protected String description
```
  - destinationType
```
protected String destinationType
```
  - displayName
```
protected String displayName
```
  - displayType
```
protected String displayType
```
  - measurementType
```
protected String measurementType
```
  - property
```
protected String property
```
  - units
```
protected MeasurementUnitsDescriptor units
```
- Constructor Detail
  - MetricDescriptor
```
public MetricDescriptor()
```
- Method Detail
  - getVersion
```
public Version getVersion()
```
    Gets the value of the version property.
    
    Returns:
    possible object is Version
  - setVersion
```
public void setVersion(Version value)
```
    Sets the value of the version property.
    
    Parameters:
    value - allowed object is Version
  - getCategory
```
public String getCategory()
```
    Gets the value of the category property.
    
    Returns:
    possible object is String
  - setCategory
```
public void setCategory(String value)
```
    Sets the value of the category property.
    
    Parameters:
    value - allowed object is String
  - getDataType
```
public String getDataType()
```
    Gets the value of the dataType property.
    
    Returns:
    possible object is String
  - setDataType
```
public void setDataType(String value)
```
    Sets the value of the dataType property.
    
    Parameters:
    value - allowed object is String
  - getDefaultInterval
```
public BigInteger getDefaultInterval()
```
    Gets the value of the defaultInterval property.
    
    Returns:
    possible object is BigInteger
  - setDefaultInterval
```
public void setDefaultInterval(BigInteger value)
```
    Sets the value of the defaultInterval property.
    
    Parameters:
    value - allowed object is BigInteger
  - isDefaultOn
```
public boolean isDefaultOn()
```
    Gets the value of the defaultOn property.
    
    Returns:
    possible object is Boolean
  - setDefaultOn
```
public void setDefaultOn(Boolean value)
```
    Sets the value of the defaultOn property.
    
    Parameters:
    value - allowed object is Boolean
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    value - allowed object is String
  - getDestinationType
```
public String getDestinationType()
```
    Gets the value of the destinationType property.
    
    Returns:
    possible object is String
  - setDestinationType
```
public void setDestinationType(String value)
```
    Sets the value of the destinationType property.
    
    Parameters:
    value - allowed object is String
  - getDisplayName
```
public String getDisplayName()
```
    Gets the value of the displayName property.
    
    Returns:
    possible object is String
  - setDisplayName
```
public void setDisplayName(String value)
```
    Sets the value of the displayName property.
    
    Parameters:
    value - allowed object is String
  - getDisplayType
```
public String getDisplayType()
```
    Gets the value of the displayType property.
    
    Returns:
    possible object is String
  - setDisplayType
```
public void setDisplayType(String value)
```
    Sets the value of the displayType property.
    
    Parameters:
    value - allowed object is String
  - getMeasurementType
```
public String getMeasurementType()
```
    Gets the value of the measurementType property.
    
    Returns:
    possible object is String
  - setMeasurementType
```
public void setMeasurementType(String value)
```
    Sets the value of the measurementType property.
    
    Parameters:
    value - allowed object is String
  - getProperty
```
public String getProperty()
```
    Gets the value of the property property.
    
    Returns:
    possible object is String
  - setProperty
```
public void setProperty(String value)
```
    Sets the value of the property property.
    
    Parameters:
    value - allowed object is String
  - getUnits
```
public MeasurementUnitsDescriptor getUnits()
```
    Gets the value of the units property.
    
    Returns:
    possible object is MeasurementUnitsDescriptor
  - setUnits
```
public void setUnits(MeasurementUnitsDescriptor value)
```
    Sets the value of the units property.
    
    Parameters:
    value - allowed object is MeasurementUnitsDescriptor

Class MetricDescriptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

version

category

dataType

defaultInterval

defaultOn

description

destinationType

displayName

displayType

measurementType

property

units

Constructor Detail

MetricDescriptor

Method Detail

getVersion

setVersion

getCategory

setCategory

getDataType

setDataType

getDefaultInterval

setDefaultInterval

isDefaultOn

setDefaultOn

getDescription

setDescription

getDestinationType

setDestinationType

getDisplayName

setDisplayName

getDisplayType

setDisplayType

getMeasurementType

setMeasurementType

getProperty

setProperty

getUnits

setUnits