Module io.prometheus.metrics.expositionformats
Package io.prometheus.metrics.expositionformats.generated.com_google_protobuf_4_33_0

Interface Metrics.MetricFamilyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Metrics.MetricFamily, Metrics.MetricFamily.Builder
Enclosing class:
Metrics
public static interface Metrics.MetricFamilyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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;
    Metrics.MetricType
    getType()
    optional .io.prometheus.client.MetricType type = 3;
    String
    getUnit()
    optional string unit = 5;
    com.google.protobuf.ByteString
    getUnitBytes()
    optional string unit = 5;
    boolean
    hasHelp()
    optional string help = 2;
    boolean
    hasName()
    optional string name = 1;
    boolean
    hasType()
    optional .io.prometheus.client.MetricType type = 3;
    boolean
    hasUnit()
    optional string unit = 5;

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasName

      boolean hasName()
      optional string name = 1;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
      optional string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
      optional string name = 1;
      Returns:
      The bytes for name.

    • hasHelp

      boolean hasHelp()
      optional string help = 2;
      Returns:
      Whether the help field is set.

    • getHelp

      String getHelp()
      optional string help = 2;
      Returns:
      The help.

    • getHelpBytes

      com.google.protobuf.ByteString getHelpBytes()
      optional string help = 2;
      Returns:
      The bytes for help.

    • hasType

      boolean hasType()
      optional .io.prometheus.client.MetricType type = 3;
      Returns:
      Whether the type field is set.

    • getType

      Metrics.MetricType getType()
      optional .io.prometheus.client.MetricType type = 3;
      Returns:
      The type.

    • getMetricList

      List<Metrics.Metric> getMetricList()
      repeated .io.prometheus.client.Metric metric = 4;

    • getMetric

      Metrics.Metric getMetric(int index)
      repeated .io.prometheus.client.Metric metric = 4;

    • getMetricCount

      int getMetricCount()
      repeated .io.prometheus.client.Metric metric = 4;

    • getMetricOrBuilderList

      List<? extends Metrics.MetricOrBuilder> getMetricOrBuilderList()
      repeated .io.prometheus.client.Metric metric = 4;

    • getMetricOrBuilder

      Metrics.MetricOrBuilder getMetricOrBuilder(int index)
      repeated .io.prometheus.client.Metric metric = 4;

    • hasUnit

      boolean hasUnit()
      optional string unit = 5;
      Returns:
      Whether the unit field is set.

    • getUnit

      String getUnit()
      optional string unit = 5;
      Returns:
      The unit.

    • getUnitBytes

      com.google.protobuf.ByteString getUnitBytes()
      optional string unit = 5;
      Returns:
      The bytes for unit.