com.ibm.streams.operator.control

Enum RegionMonitorMXBean.Health

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RegionMonitorMXBean.Health>
    Enclosing interface:
    RegionMonitorMXBean

    public static enum RegionMonitorMXBean.Health
extends java.lang.Enum<RegionMonitorMXBean.Health>
    The health of a region as an aggregation of the health of the PEs for the region.
    Since:
    InfoSphere® Streams Version 4.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant and Description
      HEALTHY
      All of the PEs in the region are HEALTHY.
      PARTIALLY_HEALTHY
      At least one PE is PARTIALLY_HEALTHY and no PEs are PARTIALLY_UNHEALTHY or UNHEALTHY.
      PARTIALLY_UNHEALTHY
      At least one PE is PARTIALLY_UNHEALTHY and no PEs are UNHEALTHY.
      UNHEALTHY
      At least one PE is UNHEALTHY.
      UNKNOWN
      The health of PEs in the region is unknown.

    • Method Summary

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

      • HEALTHY

        public static final RegionMonitorMXBean.Health HEALTHY
        All of the PEs in the region are HEALTHY. A PE is HEALTHY when it is running and all of the required and optional connections are connected

      • UNHEALTHY

        public static final RegionMonitorMXBean.Health UNHEALTHY
        At least one PE is UNHEALTHY. A PE is UNHEALTHY when it is stopped or is in the process of stopping.

      • PARTIALLY_HEALTHY

        public static final RegionMonitorMXBean.Health PARTIALLY_HEALTHY
        At least one PE is PARTIALLY_HEALTHY and no PEs are PARTIALLY_UNHEALTHY or UNHEALTHY. A PE is PARTIALLY_HEALTHY when it is PE is running and all of the required connections are connected, but some of the optional connections are in the process of being connected.

      • PARTIALLY_UNHEALTHY

        public static final RegionMonitorMXBean.Health PARTIALLY_UNHEALTHY
        At least one PE is PARTIALLY_UNHEALTHY and no PEs are UNHEALTHY. A PE is PARTIALLY_UNHEALTHY when it is not stopped or in the process of stopping, but either the state is not running or some required connections are not yet connected.

      • UNKNOWN

        public static final RegionMonitorMXBean.Health UNKNOWN
        The health of PEs in the region is unknown. The health of the region is unknown when the Job Control Plane starts or restarts, and if the connection to the Domain JMX is lost.

    • Method Detail

      • values

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

      • valueOf

        public static RegionMonitorMXBean.Health 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