## Uses of Class
com.h3c.sdn.metric.MetricDescriptor

- Packages that use MetricDescriptor
  Package | Description
  --- | ---
  com.h3c.sdn.adm.json | Implementations of Core Services JSON factory and associated codecs.
  com.h3c.sdn.adm.metric | Definitions of services pertaining to the SDN core controller metering framework.
  com.h3c.sdn.metric | Fundamental classes for the SDN core controller metering framework, including the classes for various metric types that may be obtained from the framework.

- - ### Uses of MetricDescriptor in com.h3c.sdn.adm.json

    Classes in com.h3c.sdn.adm.json with type parameters of type MetricDescriptor
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractMetricDescriptorCodec<T extends MetricDescriptor>` A JSON codec capable of encoding and decoding `MetricDescriptor` objects.

  - ### Uses of MetricDescriptor in com.h3c.sdn.adm.metric

    Methods in com.h3c.sdn.adm.metric that return MetricDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `MetricDescriptor` | MetricService.`getMetric(String uid)` Returns the descriptor details of an existing metric if found

    Methods in com.h3c.sdn.adm.metric that return types with arguments of type MetricDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `Map<MetricDescriptor,String>` | MetricService.`getPersistedMetrics(String appId, String primaryTag, String secondaryTag, String name)` Returns all persisted metrics registered and available from the specified application, primaryTag, secondaryTag and metric name.

  - ### Uses of MetricDescriptor in com.h3c.sdn.metric

    Classes in com.h3c.sdn.metric with type parameters of type MetricDescriptor
    Modifier and Type | Class and Description
    --- | ---
    `static class` | `MetricDescriptor.MetricDescriptorBuilder<T extends MetricDescriptor>` Metric descriptor builder object, which requires that only arguments that are mandatory for the construction of a `MetricDescriptor` be specified during its own construction.

    Subclasses of MetricDescriptor in com.h3c.sdn.metric
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CounterDescriptor` Counter descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedCounter` object.
    `class` | `GaugeDescriptor` Gauge descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedGauge` object.
    `class` | `HistogramDescriptor` Histogram descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedHistogram` object.
    `class` | `MeterDescriptor` Meter descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedMeter` object.
    `class` | `RatioGaugeDescriptor` Ratio gauge descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedRatioGauge` object.
    `class` | `RollingCounterDescriptor` Rolling counter descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedRollingCounter` object.
    `class` | `TimerDescriptor` Timer descriptor object, which specifies numerous properties that shape the processing and handling of a `TimeStampedTimer` object.

    Methods in com.h3c.sdn.metric that return MetricDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `MetricDescriptor` | TimeStampedMetric.`getDescriptor()` Gets the `MetricDescriptor` that describes this `TimeStampedMetric` object.
    `MetricDescriptor` | TimeStampedMetricDescriptor.`getDescriptor()` Gets the `MetricDescriptor`.
    `MetricDescriptor` | UidMetricDescriptor.`getDescriptor()` Gets the `MetricDescriptor`.

    Methods in com.h3c.sdn.metric that return types with arguments of type MetricDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `SortedMap<MetricDescriptor,TimeStampedCounter>` | MetricRegistry.`getCounters()` Returns a map of all `TimeStampedCounter`s from the registry, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedCounter>` | MetricRegistry.`getCounters(MetricFilter filter)` Returns a map of `TimeStampedCounter`s from the registry that match the given `MetricFilter`, along with their `MetricDescriptor`s.
    `Set<MetricDescriptor>` | MetricRegistry.`getDescriptors()` Returns a set of the `MetricDescriptor`s of all the `TimeStampedMetric`s in the registry.
    `SortedMap<MetricDescriptor,TimeStampedGauge>` | MetricRegistry.`getGauges()` Returns a map of all `TimeStampedGauge`s from the registry, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedGauge>` | MetricRegistry.`getGauges(MetricFilter filter)` Returns a map of `TimeStampedGauge`s from the registry that match the given `MetricFilter`, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedHistogram>` | MetricRegistry.`getHistograms()` Returns a map of all `TimeStampedHistogram`s from the registry, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedHistogram>` | MetricRegistry.`getHistograms(MetricFilter filter)` Returns a map of `TimeStampedHistogram`s from the registry that match the given `MetricFilter`, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedMeter>` | MetricRegistry.`getMeters()` Returns a map of all `TimeStampedMeter`s from the registry, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedMeter>` | MetricRegistry.`getMeters(MetricFilter filter)` Returns a map of `TimeStampedMeter`s from the registry that match the given `MetricFilter`, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedRatioGauge>` | MetricRegistry.`getRatioGauges()` Returns a map of all `TimeStampedRatioGauge`s from the registry, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedRatioGauge>` | MetricRegistry.`getRatioGauges(MetricFilter filter)` Returns a map of `TimeStampedRatioGauge`s from the registry that match the given `MetricFilter`, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedRollingCounter>` | MetricRegistry.`getRollingCounters()` Returns a map of all `TimeStampedRollingCounter`s from the registry, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedRollingCounter>` | MetricRegistry.`getRollingCounters(MetricFilter filter)` Returns a map of `TimeStampedRollingCounter`s from the registry that match the given `MetricFilter`, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedTimer>` | MetricRegistry.`getTimers()` Returns a map of all `TimeStampedTimer`s from the registry, along with their `MetricDescriptor`s.
    `SortedMap<MetricDescriptor,TimeStampedTimer>` | MetricRegistry.`getTimers(MetricFilter filter)` Returns a map of `TimeStampedTimer`s from the registry that match the given `MetricFilter`, along with their `MetricDescriptor`s.
    `Map<MetricDescriptor,TimeStampedMetric>` | MetricRegistry.`getTimeStampedMetrics()` Returns a copy of the `Map` used by the `MetricRegistry` to track registered `TimeStampedMetric`s.

    Methods in com.h3c.sdn.metric with parameters of type MetricDescriptor
    Modifier and Type | Method and Description
    --- | ---
    `int` | MetricDescriptor.`compareTo(MetricDescriptor toCompare)`
    `boolean` | MetricFilter.`matches(MetricDescriptor descriptor)` Returns `true` if the specified `MetricDescriptor` matches the filter; `false` otherwise.
    `TimeStampedMetric` | MetricRegistry.`register(MetricDescriptor descriptor, TimeStampedMetric metric)` Given a `TimeStampedMetric`, registers it using the provided `MetricDescriptor`.
    `boolean` | MetricRegistry.`remove(MetricDescriptor descriptor)` Unregisters the `TimeStampedMetric` corresponding to the specified `MetricDescriptor`.

    Constructors in com.h3c.sdn.metric with parameters of type MetricDescriptor
    Constructor and Description
    `TimeStampedMetricDescriptor(MetricDescriptor descriptor)` Creates a new `TimeStampedMetricDescriptor` using the current time.
    `TimeStampedMetricDescriptor(MetricDescriptor descriptor, long timeStamp)` Creates a new `TimeStampedMetricDescriptor` using the specified time stamp.
    `UidMetricDescriptor(MetricDescriptor descriptor, String uid)` Creates a new `UidMetricDescriptor` using the current time.

Copyright © 2014. All Rights Reserved.