Class MetricCapDescriptor


  • public class MetricCapDescriptor
    extends java.lang.Object
    Provides descriptive information that controls the monthly aggregation algorithm used by the metering service for calculating either hourly or peak values for a metric.

    A MetricCapDescriptor is only used for reporting purposes when the associated product has been identified as the primary product; see ProductExtension.getProductWeight().

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String CAP_ALGORITHM_CONCURRENT
      Metric capping attribute name to use the concurrent total capping algorithm.
      static java.lang.String CAP_ALGORITHM_CONCURRENT_MAX
      Metric capping attribute name to use the concurrent maximum capping algorithm.
      static java.lang.String CAP_ALGORITHM_SHARED
      Metric capping attribute name to use the shared total capping algorithm.
    • Constructor Summary

      Constructors 
      Constructor Description
      MetricCapDescriptor​(java.lang.String capMetricType, java.lang.Number cap)
      Constructs a MetricCapDescriptor with all required descriptor attributes.
      MetricCapDescriptor​(java.lang.String capMetricType, java.lang.Number cap, java.lang.String capAlgorithm, java.lang.String capGroupId)
      Constructs a MetricCapDescriptor with all available descriptor attributes.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Number getCap()
      Returns the maximum time in milliseconds per month that will be included for the cap metric type in the monthly report.
      java.lang.String getCapAlgorithm()
      Returns the cap algorithm which is used to aggregate the capped metric value.
      java.lang.String getCapGroupId()
      Returns the group identifier to which the capping algorithm will be applied; null indicates the capping algorithm will be applied to the registered instance.
      java.lang.String getCapMetricType()
      Returns the metric type to be aggregated by the metering service in the monthly report.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • CAP_ALGORITHM_CONCURRENT

        public static final java.lang.String CAP_ALGORITHM_CONCURRENT
        Metric capping attribute name to use the concurrent total capping algorithm.
        See Also:
        Constant Field Values
      • CAP_ALGORITHM_SHARED

        public static final java.lang.String CAP_ALGORITHM_SHARED
        Metric capping attribute name to use the shared total capping algorithm.
        See Also:
        Constant Field Values
      • CAP_ALGORITHM_CONCURRENT_MAX

        public static final java.lang.String CAP_ALGORITHM_CONCURRENT_MAX
        Metric capping attribute name to use the concurrent maximum capping algorithm.
        See Also:
        Constant Field Values
    • Constructor Detail

      • MetricCapDescriptor

        public MetricCapDescriptor​(java.lang.String capMetricType,
                                   java.lang.Number cap,
                                   java.lang.String capAlgorithm,
                                   java.lang.String capGroupId)
        Constructs a MetricCapDescriptor with all available descriptor attributes.

        A MetricCapDescriptor may provide the following attributes:

        Parameters:
        capMetricType - the metric type that will be aggregated by the metering service in the monthly report
        cap - the maximum time in milliseconds per month that will be included for the capMetricType for the monthly report
        capAlgorithm - the algorithm used by the metering service for the metric in the monthly report
        capGroupId - the group identifier to which the capping algorithm will be applied; null indicates the capping algorithm will be applied to the registered instance.
    • Method Detail

      • getCapMetricType

        public java.lang.String getCapMetricType()
        Returns the metric type to be aggregated by the metering service in the monthly report.
        Returns:
        the cap metric type
      • getCap

        public java.lang.Number getCap()
        Returns the maximum time in milliseconds per month that will be included for the cap metric type in the monthly report.
        Returns:
        the cap
      • getCapAlgorithm

        public java.lang.String getCapAlgorithm()
        Returns the cap algorithm which is used to aggregate the capped metric value.
        Returns:
        the cap algorithm
      • getCapGroupId

        public java.lang.String getCapGroupId()
        Returns the group identifier to which the capping algorithm will be applied; null indicates the capping algorithm will be applied to the registered instance.
        Returns:
        the cap group identifier
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object