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 theName
.Description
: (Optional) A human readable description of the metric.Type
: (Required) The type of the metric. SeeMetricType
.Unit
: (Optional) The unit of the metric. The unit may be any unit specified as a String or one specified inMetricUnits
.
-
Method Summary
Modifier and TypeMethodDescriptionstatic MetadataBuilder
builder()
Returns a new builderstatic MetadataBuilder
Returns a new builder with theMetadata
informationReturns the description of the metric if set, otherwise this method returns the emptyString
.Returns the display name if set, otherwise this method returns the metric name.getName()
Returns the metric name.getType()
Returns the String representation of theMetricType
.Returns theMetricType
of the metric if set, otherwise it returnsMetricType.INVALID
getUnit()
Returns the unit of this metric if set, otherwise this method returnsMetricUnits.NONE
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
-
getDescription
String getDescription()Returns the description of the metric if set, otherwise this method returns the emptyString
.- Returns:
- the description
-
description
-
getType
String getType()Returns the String representation of theMetricType
.- Returns:
- the MetricType as a String
- See Also:
-
getTypeRaw
MetricType getTypeRaw()Returns theMetricType
of the metric if set, otherwise it returnsMetricType.INVALID
- Returns:
- the
MetricType
-
getUnit
String getUnit()Returns the unit of this metric if set, otherwise this method returnsMetricUnits.NONE
- Returns:
- the unit
-
unit
-
builder
Returns a new builder- Returns:
- a new
MetadataBuilder
instance
-
builder
Returns a new builder with theMetadata
information- Parameters:
metadata
- the metadata- Returns:
- a new
MetadataBuilder
instance with theMetadata
values - Throws:
NullPointerException
- when metadata is null
-