Package org.eclipse.microprofile.metrics

Interface Metadata

All Known Implementing Classes:

DefaultMetadata

public interface Metadata

Bean holding the metadata of one single metric.

The metadata contains:

• Name: (Required) The name of the metric.
• Display name: (Optional) The display (friendly) name of the metric. By default, it is set to the Name.
• Description: (Optional) A human readable description of the metric.
• Type: (Required) The type of the metric. See MetricType.
• Unit: (Optional) The unit of the metric. The unit may be any unit specified as a String or one specified in MetricUnits.

Method Summary

Modifier and Type	Method	Description
static MetadataBuilder	builder()	Returns a new builder
static MetadataBuilder	builder(Metadata metadata)	Returns a new builder with the Metadata information
Optional<String>	description()
Optional<String>	displayName()
String	getDescription()	Returns the description of the metric if set, otherwise this method returns the empty String.
String	getDisplayName()	Returns the display name if set, otherwise this method returns the metric name.
String	getName()	Returns the metric name.
String	getType()	Returns the String representation of the MetricType.
MetricType	getTypeRaw()	Returns the MetricType of the metric if set, otherwise it returns MetricType.INVALID
String	getUnit()	Returns the unit of this metric if set, otherwise this method returns MetricUnits.NONE
Optional<String>	unit()

Method Details

getName

String getName()

Returns the metric name.

Returns:

the metric name.

getDisplayName

String getDisplayName()

Returns the display name if set, otherwise this method returns the metric name.

Returns:

the display name

displayName

Optional<String> displayName()

getDescription

String getDescription()

Returns the description of the metric if set, otherwise this method returns the empty String.

Returns:

the description

description

Optional<String> description()

getType

String getType()

Returns the String representation of the MetricType.

Returns:

the MetricType as a String

See Also:

• MetricType

getTypeRaw

MetricType getTypeRaw()

Returns the MetricType of the metric if set, otherwise it returns MetricType.INVALID

Returns:

the MetricType

getUnit

String getUnit()

Returns the unit of this metric if set, otherwise this method returns MetricUnits.NONE

Returns:

the unit

unit

Optional<String> unit()

builder

static MetadataBuilder builder()

Returns a new builder

Returns:

a new MetadataBuilder instance

builder

static MetadataBuilder builder(Metadata metadata)

Returns a new builder with the Metadata information

Parameters:

metadata - the metadata

Returns:

a new MetadataBuilder instance with the Metadata values

Throws:

NullPointerException - when metadata is null