Package com.ibm.wsspi.usage.metering
Class MetricGroupDescriptor
- java.lang.Object
-
- com.ibm.wsspi.usage.metering.AggregationMethodDescriptor<MetricGroupDescriptor>
-
- com.ibm.wsspi.usage.metering.MetricGroupDescriptor
-
public class MetricGroupDescriptor extends AggregationMethodDescriptor<MetricGroupDescriptor>
Provides group 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
MetricGroupDescriptor.GroupRollUp
String, specifying that this group should logically represent a single value for all instances when aggregating metrics for parent groups.-
Nested classes/interfaces inherited from class com.ibm.wsspi.usage.metering.AggregationMethodDescriptor
AggregationMethodDescriptor.RangeAggregationMethod, AggregationMethodDescriptor.SliceAggregationMethod
-
-
Constructor Summary
Constructors Constructor Description MetricGroupDescriptor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MetricGroupDescriptor
copyMetricAggregationMethods(MetricDescriptor metricDescriptor)
MetricGroupDescriptor
copyMetricAggregationMethods(MetricGroupDescriptor metricGroupDescriptor)
java.lang.String
getGroupID()
Returns the unique group identifierjava.lang.String
getGroupRollUpMethod()
Returns the group roll up method.MetricGroupDescriptor
setGroupID(java.lang.String groupID)
Set the unique group identifier.MetricGroupDescriptor
setGroupRollUpMethod(MetricGroupDescriptor.GroupRollUp groupRollUp)
Sets the group roll up type method.MetricGroupDescriptor
setRangeAggregationMethods(AggregationMethodDescriptor.RangeAggregationMethod... aggregationMethods)
Sets the aggregation type methods for an entire time range.MetricGroupDescriptor
setSliceAggregationMethods(AggregationMethodDescriptor.SliceAggregationMethod... aggregationMethods)
Sets the aggregation type methods for small time periods (for example, hours when looking at a day).-
Methods inherited from class com.ibm.wsspi.usage.metering.AggregationMethodDescriptor
getRangeAggregationMethodNames, getRangeAggregationMethods, getSliceAggregationMethodNames, getSliceAggregationMethods
-
-
-
-
Method Detail
-
setGroupRollUpMethod
public MetricGroupDescriptor setGroupRollUpMethod(MetricGroupDescriptor.GroupRollUp groupRollUp)
Sets the group roll up type method. If not provided, the metric will not be rolled up for parent groups.Allowed values:
- Parameters:
groupRollUp
- the group roll-up type method- Returns:
- a reference to this object
-
getGroupRollUpMethod
public java.lang.String getGroupRollUpMethod()
Returns the group roll up method. If not provided, the metric will not be rolled up for parent groups.Allowed values:
- Returns:
- the group roll-up method
-
getGroupID
public java.lang.String getGroupID()
Returns the unique group identifier- Returns:
- the group identifier
-
setGroupID
public MetricGroupDescriptor setGroupID(java.lang.String groupID)
Set the unique group identifier.- Parameters:
groupID
- the groupID to set- Returns:
- a reference to this object
-
copyMetricAggregationMethods
public MetricGroupDescriptor copyMetricAggregationMethods(MetricDescriptor metricDescriptor)
-
copyMetricAggregationMethods
public MetricGroupDescriptor copyMetricAggregationMethods(MetricGroupDescriptor metricGroupDescriptor)
-
setSliceAggregationMethods
public MetricGroupDescriptor setSliceAggregationMethods(AggregationMethodDescriptor.SliceAggregationMethod... aggregationMethods)
Sets the aggregation type methods for small time periods (for example, 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.
- Overrides:
setSliceAggregationMethods
in classAggregationMethodDescriptor<MetricGroupDescriptor>
- Parameters:
aggregationMethods
- the aggregation type methods for small time periods- Returns:
- a reference to this object
-
setRangeAggregationMethods
public MetricGroupDescriptor 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.
- Overrides:
setRangeAggregationMethods
in classAggregationMethodDescriptor<MetricGroupDescriptor>
- Parameters:
aggregationMethods
- the aggregation type methods for an entire time range- Returns:
- a reference to this object
-
-