Package com.ibm.wsspi.usage.metering
Class AggregationMethodDescriptor<T extends AggregationMethodDescriptor<?>>
- java.lang.Object
-
- com.ibm.wsspi.usage.metering.AggregationMethodDescriptor<T>
-
- Direct Known Subclasses:
MetricDescriptor
,MetricGroupDescriptor
public abstract class AggregationMethodDescriptor<T extends AggregationMethodDescriptor<?>> extends java.lang.Object
Provides aggregation method descriptive information about a reportedMetric
, that will be used to control how the metric information is displayed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AggregationMethodDescriptor.RangeAggregationMethod
The allowed aggregation method types for an entire time range.static class
AggregationMethodDescriptor.SliceAggregationMethod
The allowed aggregation method types for small time periods (for example, hours when looking at a day).
-
Constructor Summary
Constructors Constructor Description AggregationMethodDescriptor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<java.lang.String>
getRangeAggregationMethodNames()
java.util.Set<AggregationMethodDescriptor.RangeAggregationMethod>
getRangeAggregationMethods()
Returns the set of aggregation type methods for an entire time range.java.util.Set<java.lang.String>
getSliceAggregationMethodNames()
java.util.Set<AggregationMethodDescriptor.SliceAggregationMethod>
getSliceAggregationMethods()
Returns the set of aggregation type methods for small time periods (e.g.AggregationMethodDescriptor<T>
setRangeAggregationMethods(AggregationMethodDescriptor.RangeAggregationMethod... aggregationMethods)
Sets the aggregation type methods for an entire time range.AggregationMethodDescriptor<T>
setSliceAggregationMethods(AggregationMethodDescriptor.SliceAggregationMethod... aggregationMethods)
Sets the aggregation type methods for small time periods (e.g.
-
-
-
Method Detail
-
getSliceAggregationMethods
public java.util.Set<AggregationMethodDescriptor.SliceAggregationMethod> getSliceAggregationMethods()
Returns the set of aggregation type methods for small time periods (e.g. hours when looking at a day). If not provided, defaults to MIN, MAX, AVG.Allowed values:
The value NONE cannot be combined with other values and will result in the metric not being displayed for small time periods.
- Returns:
- the set of aggregation type methods for small time periods
-
getSliceAggregationMethodNames
public java.util.Set<java.lang.String> getSliceAggregationMethodNames()
-
getRangeAggregationMethods
public java.util.Set<AggregationMethodDescriptor.RangeAggregationMethod> getRangeAggregationMethods()
Returns the set of aggregation type methods for an entire time range. If not provided, defaults to MIN, MAX, AVG.Allowed values:
The value NONE cannot be combined with other values and will result in the metric not being displayed for the entire time range.
- Returns:
- the set of aggregation type methods for an entire time range
-
getRangeAggregationMethodNames
public java.util.Set<java.lang.String> getRangeAggregationMethodNames()
-
setSliceAggregationMethods
public AggregationMethodDescriptor<T> setSliceAggregationMethods(AggregationMethodDescriptor.SliceAggregationMethod... aggregationMethods)
Sets the aggregation type methods for small time periods (e.g. hours when looking at a day). If not specified, defaults to MIN, MAX, AVG.Allowed values:
The value NONE cannot be combined with other values and will result in the metric not being displayed for small time periods.
- Parameters:
aggregationMethods
- the aggregation type methods for small time periods- Returns:
- a reference to this object
-
setRangeAggregationMethods
public AggregationMethodDescriptor<T> setRangeAggregationMethods(AggregationMethodDescriptor.RangeAggregationMethod... aggregationMethods)
Sets the aggregation type methods for an entire time range. If not provided, defaults to MIN, MAX, AVG.Allowed values:
The value NONE cannot be combined with other values and will result in the metric not being displayed for the entire time range.
- Parameters:
aggregationMethods
- the aggregation type methods for an entire time range- Returns:
- a reference to this object
-
-