com.ibm.streams.operator.metrics

Enum Metric.Kind

  • java.lang.Object
    • java.lang.Enum<Metric.Kind>
      • com.ibm.streams.operator.metrics.Metric.Kind
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Metric.Kind>
    Enclosing interface:
    Metric

    public static enum Metric.Kind
extends java.lang.Enum<Metric.Kind>
    Kind of metric. The kind of the metric only indicates the behavior of value, it does not impose any semantics on the value. The kind is typically used by tooling applications.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      COUNTER
      A counter metric observes a value that represents a count of an occurrence.
      GAUGE
      A gauge metric observes a value that is continuously variable with time.
      TIME
      A time metric represents a point in time.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      static Metric.Kind valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Metric.Kind[] 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

      • GAUGE

        public static final Metric.Kind GAUGE
        A gauge metric observes a value that is continuously variable with time.

      • COUNTER

        public static final Metric.Kind COUNTER
        A counter metric observes a value that represents a count of an occurrence.

      • TIME

        public static final Metric.Kind TIME
        A time metric represents a point in time. The representation of time and units are specific to a metric and defined by the application.

    • Method Detail

      • values

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

      • valueOf

        public static Metric.Kind 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