Package org.springframework.boot.actuate.metrics.export.prometheus

Enum Class PrometheusOutputFormat

java.lang.Object

java.lang.Enum<PrometheusOutputFormat>

org.springframework.boot.actuate.metrics.export.prometheus.PrometheusOutputFormat

All Implemented Interfaces:

Serializable, Comparable<PrometheusOutputFormat>, Constable, Producible<PrometheusOutputFormat>

public enum PrometheusOutputFormat
extends Enum<PrometheusOutputFormat>
implements Producible<PrometheusOutputFormat>

A Producible enum for supported Prometheus formats.

Since:

3.3.0

Author:

Andy Wilkinson

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTENT_TYPE_004	Prometheus text version 0.0.4.
CONTENT_TYPE_OPENMETRICS_100	OpenMetrics text version 1.0.0.
CONTENT_TYPE_PROTOBUF	Prometheus metrics protobuf.

Method Summary

Modifier and Type	Method	Description
MimeType	getProducedMimeType()	Mime type that can be produced.
static PrometheusOutputFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PrometheusOutputFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.boot.actuate.endpoint.Producible

isDefault

Enum Constant Details

CONTENT_TYPE_004

public static final PrometheusOutputFormat CONTENT_TYPE_004

Prometheus text version 0.0.4.

CONTENT_TYPE_OPENMETRICS_100

public static final PrometheusOutputFormat CONTENT_TYPE_OPENMETRICS_100

OpenMetrics text version 1.0.0.

CONTENT_TYPE_PROTOBUF

public static final PrometheusOutputFormat CONTENT_TYPE_PROTOBUF

Prometheus metrics protobuf.

Method Details

values

public static PrometheusOutputFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PrometheusOutputFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getProducedMimeType

public MimeType getProducedMimeType()

Description copied from interface: Producible

Mime type that can be produced.

Specified by:

getProducedMimeType in interface Producible<PrometheusOutputFormat>

Returns:

the producible mime type