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

Enum TextOutputFormat

java.lang.Object

java.lang.Enum<TextOutputFormat>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TextOutputFormat>, Producible<TextOutputFormat>

public enum TextOutputFormat
extends java.lang.Enum<TextOutputFormat>
implements Producible<TextOutputFormat>

A Producible enum for supported Prometheus TextFormat.

Since:

2.5.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTENT_TYPE_004 Prometheus text version 0.0.4.
CONTENT_TYPE_OPENMETRICS_100 OpenMetrics text version 1.0.0.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTENT_TYPE_OPENMETRICS_100

public static final TextOutputFormat CONTENT_TYPE_OPENMETRICS_100

OpenMetrics text version 1.0.0.

CONTENT_TYPE_004

public static final TextOutputFormat CONTENT_TYPE_004

Prometheus text version 0.0.4.

Method Detail

values

public static TextOutputFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TextOutputFormat c : TextOutputFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static TextOutputFormat valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getProducedMimeType

public org.springframework.util.MimeType getProducedMimeType()

Description copied from interface: Producible

Mime type that can be produced.

Specified by:

getProducedMimeType in interface Producible<TextOutputFormat>

Returns:

the producible mime type