public interface Metadata
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
.Modifier and Type | Method and Description |
---|---|
static MetadataBuilder |
builder()
Returns a new builder
|
static MetadataBuilder |
builder(Metadata metadata)
Returns a new builder with the
Metadata information |
Optional<String> |
description() |
String |
getDescription()
Returns the description of the metric if set, otherwise this method returns the empty
String . |
String |
getName()
Returns the metric name.
|
String |
getUnit()
Returns the unit of this metric if set, otherwise this method returns
MetricUnits.NONE |
Optional<String> |
unit() |
String getName()
String getDescription()
String
.String getUnit()
MetricUnits.NONE
static MetadataBuilder builder()
MetadataBuilder
instancestatic MetadataBuilder builder(Metadata metadata)
Metadata
informationmetadata
- the metadataMetadataBuilder
instance with the Metadata
valuesNullPointerException
- when metadata is nullCopyright © 2017 – 2022 Eclipse Foundation. All rights reserved.
Use is subject to license terms.