Package io.opentelemetry.proto.metrics.v1

Enum DataPointFlags

java.lang.Object
java.lang.Enum<DataPointFlags>
io.opentelemetry.proto.metrics.v1.DataPointFlags
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<DataPointFlags>, java.lang.constant.Constable
public enum DataPointFlags extends Enum<DataPointFlags> implements com.google.protobuf.ProtocolMessageEnum
 DataPointFlags is defined as a protobuf 'uint32' type and is to be used as a
 bit-field representing 32 distinct boolean flags.  Each flag defined in this
 enum is a bit-mask.  To test the presence of a single flag in the flags of
 a data point, for example, use an expression like:

   (point.flags & DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK) == DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK
Protobuf enum opentelemetry.proto.metrics.v1.DataPointFlags

  • Enum Constant Details

    • DATA_POINT_FLAGS_DO_NOT_USE

      public static final DataPointFlags DATA_POINT_FLAGS_DO_NOT_USE
       The zero value for the enum. Should not be used for comparisons.
 Instead use bitwise "and" with the appropriate mask as shown above.
      DATA_POINT_FLAGS_DO_NOT_USE = 0;

    • DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK

      public static final DataPointFlags DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK
       This DataPoint is valid but has no recorded value.  This value
 SHOULD be used to reflect explicitly missing data in a series, as
 for an equivalent to the Prometheus "staleness marker".
      DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK = 1;

    • UNRECOGNIZED

      public static final DataPointFlags UNRECOGNIZED

  • Field Details

    • DATA_POINT_FLAGS_DO_NOT_USE_VALUE

      public static final int DATA_POINT_FLAGS_DO_NOT_USE_VALUE
       The zero value for the enum. Should not be used for comparisons.
 Instead use bitwise "and" with the appropriate mask as shown above.
      DATA_POINT_FLAGS_DO_NOT_USE = 0;
      See Also:

    • DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK_VALUE

      public static final int DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK_VALUE
       This DataPoint is valid but has no recorded value.  This value
 SHOULD be used to reflect explicitly missing data in a series, as
 for an equivalent to the Prometheus "staleness marker".
      DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK = 1;
      See Also:

  • Method Details

    • values

      public static DataPointFlags[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DataPointFlags 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 DataPointFlags 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 DataPointFlags 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<DataPointFlags> 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 DataPointFlags 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