Package io.prometheus.client

Class Metrics.MetricFamily

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.prometheus.client.Metrics.MetricFamily

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Metrics.MetricFamilyOrBuilder, Serializable

Enclosing class:

Metrics

public static final class Metrics.MetricFamily
extends com.google.protobuf.GeneratedMessageV3
implements Metrics.MetricFamilyOrBuilder

Protobuf type io.prometheus.client.MetricFamily

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Metrics.MetricFamily.Builder	Protobuf type io.prometheus.client.MetricFamily

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	HELP_FIELD_NUMBER
static int	METRIC_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static com.google.protobuf.Parser<Metrics.MetricFamily>	PARSER	Deprecated.
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Metrics.MetricFamily	getDefaultInstance()
Metrics.MetricFamily	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getHelp()	optional string help = 2;
com.google.protobuf.ByteString	getHelpBytes()	optional string help = 2;
Metrics.Metric	getMetric(int index)	repeated .io.prometheus.client.Metric metric = 4;
int	getMetricCount()	repeated .io.prometheus.client.Metric metric = 4;
List<Metrics.Metric>	getMetricList()	repeated .io.prometheus.client.Metric metric = 4;
Metrics.MetricOrBuilder	getMetricOrBuilder(int index)	repeated .io.prometheus.client.Metric metric = 4;
List<? extends Metrics.MetricOrBuilder>	getMetricOrBuilderList()	repeated .io.prometheus.client.Metric metric = 4;
String	getName()	optional string name = 1;
com.google.protobuf.ByteString	getNameBytes()	optional string name = 1;
com.google.protobuf.Parser<Metrics.MetricFamily>	getParserForType()
int	getSerializedSize()
Metrics.MetricType	getType()	optional .io.prometheus.client.MetricType type = 3;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasHelp()	optional string help = 2;
boolean	hasName()	optional string name = 1;
boolean	hasType()	optional .io.prometheus.client.MetricType type = 3;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Metrics.MetricFamily.Builder	newBuilder()
static Metrics.MetricFamily.Builder	newBuilder(Metrics.MetricFamily prototype)
Metrics.MetricFamily.Builder	newBuilderForType()
protected Metrics.MetricFamily.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Metrics.MetricFamily	parseDelimitedFrom(InputStream input)
static Metrics.MetricFamily	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metrics.MetricFamily	parseFrom(byte[] data)
static Metrics.MetricFamily	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metrics.MetricFamily	parseFrom(com.google.protobuf.ByteString data)
static Metrics.MetricFamily	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metrics.MetricFamily	parseFrom(com.google.protobuf.CodedInputStream input)
static Metrics.MetricFamily	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metrics.MetricFamily	parseFrom(InputStream input)
static Metrics.MetricFamily	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metrics.MetricFamily	parseFrom(ByteBuffer data)
static Metrics.MetricFamily	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Metrics.MetricFamily>	parser()
Metrics.MetricFamily.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

HELP_FIELD_NUMBER

public static final int HELP_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

METRIC_FIELD_NUMBER

public static final int METRIC_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Metrics.MetricFamily> PARSER

Deprecated.

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasName

public boolean hasName()

optional string name = 1;

Specified by:

hasName in interface Metrics.MetricFamilyOrBuilder

Returns:

Whether the name field is set.

getName

public String getName()

optional string name = 1;

Specified by:

getName in interface Metrics.MetricFamilyOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

optional string name = 1;

Specified by:

getNameBytes in interface Metrics.MetricFamilyOrBuilder

Returns:

The bytes for name.

hasHelp

public boolean hasHelp()

optional string help = 2;

Specified by:

hasHelp in interface Metrics.MetricFamilyOrBuilder

Returns:

Whether the help field is set.

getHelp

public String getHelp()

optional string help = 2;

Specified by:

getHelp in interface Metrics.MetricFamilyOrBuilder

Returns:

The help.

getHelpBytes

public com.google.protobuf.ByteString getHelpBytes()

optional string help = 2;

Specified by:

getHelpBytes in interface Metrics.MetricFamilyOrBuilder

Returns:

The bytes for help.

hasType

public boolean hasType()

optional .io.prometheus.client.MetricType type = 3;

Specified by:

hasType in interface Metrics.MetricFamilyOrBuilder

Returns:

Whether the type field is set.

getType

public Metrics.MetricType getType()

optional .io.prometheus.client.MetricType type = 3;

Specified by:

getType in interface Metrics.MetricFamilyOrBuilder

Returns:

The type.

getMetricList

public List<Metrics.Metric> getMetricList()

repeated .io.prometheus.client.Metric metric = 4;

Specified by:

getMetricList in interface Metrics.MetricFamilyOrBuilder

getMetricOrBuilderList

public List<? extends Metrics.MetricOrBuilder> getMetricOrBuilderList()

repeated .io.prometheus.client.Metric metric = 4;

Specified by:

getMetricOrBuilderList in interface Metrics.MetricFamilyOrBuilder

getMetricCount

public int getMetricCount()

repeated .io.prometheus.client.Metric metric = 4;

Specified by:

getMetricCount in interface Metrics.MetricFamilyOrBuilder

getMetric

public Metrics.Metric getMetric(int index)

repeated .io.prometheus.client.Metric metric = 4;

Specified by:

getMetric in interface Metrics.MetricFamilyOrBuilder

getMetricOrBuilder

public Metrics.MetricOrBuilder getMetricOrBuilder(int index)

repeated .io.prometheus.client.Metric metric = 4;

Specified by:

getMetricOrBuilder in interface Metrics.MetricFamilyOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Metrics.MetricFamily parseFrom(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metrics.MetricFamily parseFrom(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metrics.MetricFamily parseFrom(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metrics.MetricFamily parseFrom(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metrics.MetricFamily parseFrom(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metrics.MetricFamily parseFrom(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metrics.MetricFamily parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static Metrics.MetricFamily parseFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Metrics.MetricFamily parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static Metrics.MetricFamily parseDelimitedFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static Metrics.MetricFamily parseFrom(com.google.protobuf.CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static Metrics.MetricFamily parseFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public Metrics.MetricFamily.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Metrics.MetricFamily.Builder newBuilder()

newBuilder

public static Metrics.MetricFamily.Builder newBuilder(Metrics.MetricFamily prototype)

toBuilder

public Metrics.MetricFamily.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Metrics.MetricFamily.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Metrics.MetricFamily getDefaultInstance()

parser

public static com.google.protobuf.Parser<Metrics.MetricFamily> parser()

getParserForType

public com.google.protobuf.Parser<Metrics.MetricFamily> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Metrics.MetricFamily getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder