org.apache.nifi.controller.status.history

Interface MetricDescriptor<T>

Type Parameters:

T - type of metric

public interface MetricDescriptor<T>

Describes a particular metric that is derived from a Status History

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetricDescriptor.Formatter

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getField()
MetricDescriptor.Formatter	getFormatter() Specifies how the values should be formatted
String	getLabel()
ValueMapper<T>	getValueFunction()
ValueReducer<StatusSnapshot,Long>	getValueReducer()

Method Detail

getFormatter

MetricDescriptor.Formatter getFormatter()

Specifies how the values should be formatted

Returns:

formatter for values

getDescription

String getDescription()

Returns:

a human-readable description of the field

getLabel

String getLabel()

Returns:

a human-readable label for the field

getField

String getField()

Returns:

the name of a field

getValueFunction

ValueMapper<T> getValueFunction()

Returns:

a ValueMapper that can be used to extract a value for the status history

getValueReducer

ValueReducer<StatusSnapshot,Long> getValueReducer()

Returns:

a ValueReducer that can reduce multiple StatusSnapshots into a single Long value