public final class GaugeDefinition extends StatisticDefinition<GaugeSupplier>
IntervalTimerSupplier
.
Gauges may aggregate by either GaugeAggregator.SUM
,
GaugeAggregator.MIN
, or GaugeAggregator.MAX
.CATEGORY_GENERAL, CATEGORY_IO
Constructor and Description |
---|
GaugeDefinition(String id,
String displayName)
Creates a definition with default values.
|
Modifier and Type | Method and Description |
---|---|
GaugeSupplier |
aggregate(List<? extends StatisticSupplier> values)
Performs aggregation across statistics.
|
GaugeAggregator |
aggregator()
Returns the aggregator to use for aggregating the gauge.
|
GaugeDefinition |
aggregator(GaugeAggregator aggregator)
Sets the aggregator to use for aggregating the gauge.
|
GaugeSupplier |
cast(StatisticSupplier value)
Casts the
StatisticSupplier to this definition, substituting
a default value for null. |
GaugeDefinition |
category(String category)
Sets the category
|
GaugeSupplier |
doFinalSnapshot(StatisticSupplier supplier) |
GaugeDefinition |
nonPartitioned(boolean nonPartitioned)
Indicates that this statistic refers to a concept that is inherently
non-parallel.
|
RangeAggregator |
rangeAggregator()
Returns the aggregator to use for aggregating the gauge's range of allowed values.
|
GaugeDefinition |
rangeAggregator(RangeAggregator rangeAggregator)
Sets the aggregator to use for aggregating the gauge's range of allowed values.
|
String |
shortName()
Returns a shortened name that can be used in some ui display contexts.
|
GaugeDefinition |
shortName(String shortName)
Sets a shortened name that can be used in some ui display contexts.
|
UnitOfMeasure |
unitOfMeasure()
Returns the unit of measure.
|
GaugeDefinition |
unitOfMeasure(UnitOfMeasure unitOfMeasure)
Sets the unit of measure.
|
category, cpuTime, displayName, duration, equals, finalSnapshot, hashCode, id, ioBytes, ioCount, nonPartitioned, toString
public GaugeDefinition(String id, String displayName)
RangeAggregator.WIDEST
.id
- the id for the statisticdisplayName
- the display name of this statisticpublic GaugeAggregator aggregator()
public UnitOfMeasure unitOfMeasure()
public String shortName()
StatisticDefinition.displayName()
.public RangeAggregator rangeAggregator()
public GaugeDefinition aggregator(GaugeAggregator aggregator)
aggregator
- the aggregation for the gauge.GaugeStatisticDefinition
.public GaugeDefinition rangeAggregator(RangeAggregator rangeAggregator)
aggregator
- the aggregation for the gauge's rangeGaugeStatisticDefinition
.public GaugeDefinition unitOfMeasure(UnitOfMeasure unitOfMeasure)
unitOfMeasure
- the unit of measureGaugeStatisticDefinition
.public GaugeDefinition shortName(String shortName)
StatisticDefinition.displayName()
.shortName
- a short nameGaugeStatisticDefinition
.public GaugeDefinition category(String category)
StatisticDefinition
category
in class StatisticDefinition<GaugeSupplier>
category
- the categoryStatisticDefinition
.public GaugeSupplier aggregate(List<? extends StatisticSupplier> values)
StatisticDefinition
aggregate
in class StatisticDefinition<GaugeSupplier>
values
- the values to aggregatepublic GaugeSupplier doFinalSnapshot(StatisticSupplier supplier)
public GaugeSupplier cast(StatisticSupplier value)
StatisticDefinition
StatisticSupplier
to this definition, substituting
a default value for null.cast
in class StatisticDefinition<GaugeSupplier>
value
- the valuepublic GaugeDefinition nonPartitioned(boolean nonPartitioned)
StatisticDefinition
nonPartitioned
in class StatisticDefinition<GaugeSupplier>
nonPartitioned
- whether this statistic refers to a non-partitioned conceptStatisticDefinition
.Copyright © 2024 Actian Corporation. All rights reserved.