Package com.attivio.platform.perfmon.api

Enum SummaryType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<SummaryType>
    public enum SummaryType
extends java.lang.Enum<SummaryType>
    Indicates the type of summarization desired when fetching metric data with a period greater than the sampling period

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Maximum
      The maximum value over the time period is returned.
      Representative
      The average value over the time period is returned for COUNT based metrics.

    • Method Summary

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

      • Representative

        public static final SummaryType Representative
        The average value over the time period is returned for COUNT based metrics. For TREND based metrics, the last value is returned. The timestamp is from the center of the period.

      • Maximum

        public static final SummaryType Maximum
        The maximum value over the time period is returned. The timestamp is from the occurrence of the value.

    • Method Detail

      • values

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

      • valueOf

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