Interface Gauge.Builder<N extends Number>

Type Parameters:

N - specific subtype of Number for the gauge this builder will produce

All Superinterfaces:

Meter.Builder<Gauge.Builder<N>, Gauge<N>>, Wrapper, Wrapper

Enclosing interface:

Gauge<N extends Number>

public static interface Gauge.Builder<N extends Number>
extends Meter.Builder<Gauge.Builder<N>, Gauge<N>>

Builder for a new gauge.

See Also:

• MeterRegistry.getOrCreate(Meter.Builder)

Method Summary

Modifier and Type	Method	Description
Supplier<N>	supplier()	Returns a Supplier for the values the gauge will produce.

Methods inherited from interface Meter.Builder

addTag, baseUnit, baseUnit, description, description, identity, name, origin, origin, scope, scope, tags, tags

Modifier and Type	Method	Description
Gauge.Builder<N>	addTag(Tag tag)	Adds a single tag to the builder's collection.
Optional<String>	baseUnit()	Returns the base unit the builder will use.
Gauge.Builder<N>	baseUnit(String baseUnit)	Sets the units.
Optional<String>	description()	Returns the description the builder will use.
Gauge.Builder<N>	description(String description)	Sets the description.
default Gauge.Builder<N>	identity()	Returns the type-correct "this".
String	name()	Returns the name the builder will use.
default Optional<String>	origin()	Returns the fully-qualified name of the type which originated the meter, if set.
default Gauge.Builder<N>	origin(String origin)	Sets the fully-qualified name of the type which originated the meter.
default Optional<String>	scope()	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics does not assign scopes, and this method will be removed.
default Gauge.Builder<N>	scope(String scope)	Deprecated, for removal: This API element is subject to removal in a future version. No-op, will be removed.
Map<String,String>	tags()	Returns the tags the builder will use.
Gauge.Builder<N>	tags(Iterable<Tag> tags)	Sets the tags to use in identifying the build meter.

Methods inherited from interface Wrapper

unwrap

Modifier and Type	Method	Description
<T> T	unwrap(Class<? extends T> type)	Unwraps the delegate as the specified type.

Method Details

supplier

Supplier<N> supplier()

Returns a Supplier for the values the gauge will produce.

Returns:

supplier for the values