MicroProfile 7.0 · org.eclipse.microprofile.metrics.Metadata

Bean holding the metadata of one single metric.

The metadata contains:

Name: (Required) The name of the metric.
Description: (Optional) A human readable description of the metric.
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 and Description
public static MetadataBuilder	Returns: a new `MetadataBuilder` instance builder() Returns a new builder
public static MetadataBuilder	Returns: a new `MetadataBuilder` instance with the `Metadata` values builder(Metadata the metadata metadata) Returns a new builder with the `Metadata` information
public Optional<String>	description()
public String	Returns: the description getDescription() Returns the description of the metric if set, otherwise this method returns the empty `String`.
public String	Returns: the metric name. getName() Returns the metric name.
public String	Returns: the unit getUnit() Returns the unit of this metric if set, otherwise this method returns `MetricUnits#NONE`
public Optional<String>	unit()

builder back to summary

builder	back to summary
public static MetadataBuilder builder() Returns a new builder Returns:MetadataBuilder a new `MetadataBuilder` instance

public static MetadataBuilder builder()

Returns a new builder

builder back to summary

public static MetadataBuilder builder(Metadata metadata)

Returns a new builder with the Metadata information

Parameters

a new MetadataBuilder instance with the Metadata values

Exceptions

description	back to summary
public Optional<String> description()

getDescription back to summary

getDescription	back to summary
public String getDescription() Returns the description of the metric if set, otherwise this method returns the empty `String`. Returns:String the description

public String getDescription()

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

getName	back to summary
public String getName() Returns the metric name. Returns:String the metric name.

getName

public String getName()

Returns the metric name.

getUnit back to summary

getUnit	back to summary
public String getUnit() Returns the unit of this metric if set, otherwise this method returns `MetricUnits#NONE` Returns:String the unit

public String getUnit()

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

unit	back to summary
public Optional<String> unit()