com.ibm.streams.operator.metrics

Enum OperatorMetrics.OutputPortMetric

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      nFinalPunctsSubmitted
      Number of final punctuation marks submitted on an output port.
      nTuplesSubmitted
      Number of tuples submitted on an output port.
      nWindowPunctsSubmitted
      Number of window punctuation marks submitted on an output port.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      Metric getMetric(OperatorContext context, int port)
      Convenience method to get the Metric for a specific operator port.
      static OperatorMetrics.OutputPortMetric valueOf(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OperatorMetrics.OutputPortMetric[] 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

    • Method Detail

      • values

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

      • valueOf

        public static OperatorMetrics.OutputPortMetric 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

      • getMetric

        public Metric getMetric(OperatorContext context,
               int port)
        Convenience method to get the Metric for a specific operator port.
        Parameters:
        context - Operator's context.
        port - Operator port.
        Returns:
        The Metric object for this operator output port metric.
        Throws:
        java.lang.IllegalStateException - Operator has been shutdown and the metric has not been accessed previously.