Module io.prometheus.metrics.core

Package io.prometheus.metrics.core.metrics

Class StateSet.Builder

java.lang.Object

io.prometheus.metrics.core.metrics.Metric.Builder<StateSet.Builder,StateSet>

io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder<StateSet.Builder,StateSet>

io.prometheus.metrics.core.metrics.StateSet.Builder

Enclosing class:

StateSet

public static class StateSet.Builder
extends MetricWithFixedMetadata.Builder<StateSet.Builder,StateSet>

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	exemplarsEnabled

Fields inherited from class io.prometheus.metrics.core.metrics.Metric.Builder

constLabels, illegalLabelNames, properties

Method Summary

Modifier and Type	Method	Description
StateSet	build()
io.prometheus.metrics.config.MetricsProperties	getDefaultProperties()	Override if there are more properties than just exemplars enabled.
protected StateSet.Builder	self()
StateSet.Builder	states(Class<? extends Enum<?>> enumClass)	Declare the states that should be represented by this StateSet.
StateSet.Builder	states(String... stateNames)	Declare the states that should be represented by this StateSet.
protected io.prometheus.metrics.config.MetricsProperties	toProperties()	Override if there are more properties than just exemplars enabled.
StateSet.Builder	withExemplars()	Allow Exemplars for this metric.
StateSet.Builder	withoutExemplars()	Turn off Exemplars for this metric.

Methods inherited from class io.prometheus.metrics.core.metrics.MetricWithFixedMetadata.Builder

constLabels, help, labelNames, name, unit

Methods inherited from class io.prometheus.metrics.core.metrics.Metric.Builder

register, register

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

exemplarsEnabled

@Nullable
protected Boolean exemplarsEnabled

Method Details

states

public StateSet.Builder states(Class<? extends Enum<?>> enumClass)

Declare the states that should be represented by this StateSet.

states

public StateSet.Builder states(String... stateNames)

Declare the states that should be represented by this StateSet.

build

public StateSet build()

Specified by:

build in class MetricWithFixedMetadata.Builder<StateSet.Builder,StateSet>

self

protected StateSet.Builder self()

Specified by:

self in class MetricWithFixedMetadata.Builder<StateSet.Builder,StateSet>

withExemplars

public StateSet.Builder withExemplars()

Allow Exemplars for this metric.

withoutExemplars

public StateSet.Builder withoutExemplars()

Turn off Exemplars for this metric.

toProperties

protected io.prometheus.metrics.config.MetricsProperties toProperties()

Override if there are more properties than just exemplars enabled.

getDefaultProperties

public io.prometheus.metrics.config.MetricsProperties getDefaultProperties()

Override if there are more properties than just exemplars enabled.