org.apache.nifi.controller.status.history

Interface MetricDescriptor<T>

Type Parameters:

T -

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

Methods

Modifier and Type	Method and Description
String	getDescription() Returns a human-readable description of the field
String	getField() Returns the name of a field
MetricDescriptor.Formatter	getFormatter() Specifies how the values should be formatted
String	getLabel() Returns a human-readable label for the field
ValueMapper<T>	getValueFunction() Returns a ValueMapper that can be used to extract a value for the status history
ValueReducer<StatusSnapshot,Long>	getValueReducer() Returns a ValueReducer that can reduce multiple StatusSnapshots into a single Long value

Method Detail

getFormatter

MetricDescriptor.Formatter getFormatter()

Specifies how the values should be formatted

Returns:

getDescription

String getDescription()

Returns a human-readable description of the field

Returns:

getLabel

String getLabel()

Returns a human-readable label for the field

Returns:

getField

String getField()

Returns the name of a field

Returns:

getValueFunction

ValueMapper<T> getValueFunction()

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

Returns:

getValueReducer

ValueReducer<StatusSnapshot,Long> getValueReducer()

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

Returns: