Package io.opencensus.proto.metrics.v1

Enum MetricDescriptor.Type

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<MetricDescriptor.Type>
    Enclosing class:
    MetricDescriptor
    public static enum MetricDescriptor.Type
extends Enum<MetricDescriptor.Type>
implements com.google.protobuf.ProtocolMessageEnum
     The kind of metric. It describes how the data is reported.
 A gauge is an instantaneous measurement of a value.
 A cumulative measurement is a value accumulated over a time interval. In
 a time series, cumulative measurements should have the same start time,
 increasing values and increasing end times, until an event resets the
 cumulative value to zero and sets a new start time for the following
 points.
    Protobuf enum opencensus.proto.metrics.v1.MetricDescriptor.Type

    • Enum Constant Detail

      • UNSPECIFIED

        public static final MetricDescriptor.Type UNSPECIFIED
         Do not use this default value.
        UNSPECIFIED = 0;

      • GAUGE_INT64

        public static final MetricDescriptor.Type GAUGE_INT64
         Integer gauge. The value can go both up and down.
        GAUGE_INT64 = 1;

      • GAUGE_DOUBLE

        public static final MetricDescriptor.Type GAUGE_DOUBLE
         Floating point gauge. The value can go both up and down.
        GAUGE_DOUBLE = 2;

      • GAUGE_DISTRIBUTION

        public static final MetricDescriptor.Type GAUGE_DISTRIBUTION
         Distribution gauge measurement. The count and sum can go both up and
 down. Recorded values are always >= 0.
 Used in scenarios like a snapshot of time the current items in a queue
 have spent there.
        GAUGE_DISTRIBUTION = 3;

      • CUMULATIVE_INT64

        public static final MetricDescriptor.Type CUMULATIVE_INT64
         Integer cumulative measurement. The value cannot decrease, if resets
 then the start_time should also be reset.
        CUMULATIVE_INT64 = 4;

      • CUMULATIVE_DOUBLE

        public static final MetricDescriptor.Type CUMULATIVE_DOUBLE
         Floating point cumulative measurement. The value cannot decrease, if
 resets then the start_time should also be reset. Recorded values are
 always >= 0.
        CUMULATIVE_DOUBLE = 5;

      • CUMULATIVE_DISTRIBUTION

        public static final MetricDescriptor.Type CUMULATIVE_DISTRIBUTION
         Distribution cumulative measurement. The count and sum cannot decrease,
 if resets then the start_time should also be reset.
        CUMULATIVE_DISTRIBUTION = 6;

      • SUMMARY

        public static final MetricDescriptor.Type SUMMARY
         Some frameworks implemented Histograms as a summary of observations
 (usually things like request durations and response sizes). While it
 also provides a total count of observations and a sum of all observed
 values, it calculates configurable percentiles over a sliding time
 window. This is not recommended, since it cannot be aggregated.
        SUMMARY = 7;

    • Field Detail

      • UNSPECIFIED_VALUE

        public static final int UNSPECIFIED_VALUE
         Do not use this default value.
        UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • GAUGE_INT64_VALUE

        public static final int GAUGE_INT64_VALUE
         Integer gauge. The value can go both up and down.
        GAUGE_INT64 = 1;
        See Also:
        Constant Field Values

      • GAUGE_DOUBLE_VALUE

        public static final int GAUGE_DOUBLE_VALUE
         Floating point gauge. The value can go both up and down.
        GAUGE_DOUBLE = 2;
        See Also:
        Constant Field Values

      • GAUGE_DISTRIBUTION_VALUE

        public static final int GAUGE_DISTRIBUTION_VALUE
         Distribution gauge measurement. The count and sum can go both up and
 down. Recorded values are always >= 0.
 Used in scenarios like a snapshot of time the current items in a queue
 have spent there.
        GAUGE_DISTRIBUTION = 3;
        See Also:
        Constant Field Values

      • CUMULATIVE_INT64_VALUE

        public static final int CUMULATIVE_INT64_VALUE
         Integer cumulative measurement. The value cannot decrease, if resets
 then the start_time should also be reset.
        CUMULATIVE_INT64 = 4;
        See Also:
        Constant Field Values

      • CUMULATIVE_DOUBLE_VALUE

        public static final int CUMULATIVE_DOUBLE_VALUE
         Floating point cumulative measurement. The value cannot decrease, if
 resets then the start_time should also be reset. Recorded values are
 always >= 0.
        CUMULATIVE_DOUBLE = 5;
        See Also:
        Constant Field Values

      • CUMULATIVE_DISTRIBUTION_VALUE

        public static final int CUMULATIVE_DISTRIBUTION_VALUE
         Distribution cumulative measurement. The count and sum cannot decrease,
 if resets then the start_time should also be reset.
        CUMULATIVE_DISTRIBUTION = 6;
        See Also:
        Constant Field Values

      • SUMMARY_VALUE

        public static final int SUMMARY_VALUE
         Some frameworks implemented Histograms as a summary of observations
 (usually things like request durations and response sizes). While it
 also provides a total count of observations and a sum of all observed
 values, it calculates configurable percentiles over a sliding time
 window. This is not recommended, since it cannot be aggregated.
        SUMMARY = 7;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static MetricDescriptor.Type[] 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 (MetricDescriptor.Type c : MetricDescriptor.Type.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static MetricDescriptor.Type valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getNumber

        public final int getNumber()
        Specified by:
        getNumber in interface com.google.protobuf.Internal.EnumLite
        Specified by:
        getNumber in interface com.google.protobuf.ProtocolMessageEnum

      • valueOf

        @Deprecated
public static MetricDescriptor.Type valueOf​(int value)
        Deprecated.
        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:
        value - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • forNumber

        public static MetricDescriptor.Type forNumber​(int value)
        Parameters:
        value - The numeric wire value of the corresponding enum entry.
        Returns:
        The enum associated with the given numeric wire value.

      • internalGetValueMap

        public static com.google.protobuf.Internal.EnumLiteMap<MetricDescriptor.Type> internalGetValueMap()

      • getValueDescriptor

        public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
        Specified by:
        getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptorForType

        public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

      • getDescriptor

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

      • valueOf

        public static MetricDescriptor.Type valueOf​(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
        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:
        desc - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null