Health (sdn-apidoc 2.5.14 API)

java.lang.Object
- com.hp.sdn.app.Health

```
public class Health
extends Object
```
Data object to capture health information from a given contributor.

Author:

Liem Nguyen

Method Summary

Methods
Modifier and Type	Method and Description
`static Health`	`critical(String reason)` Creates a critical status.
`boolean`	`equals(Object o)`
`String`	`getHealthCode()` Returns a human-readable health code.
`String`	`getHealthReason()` Returns the reason for the health of application.
`int`	`hashCode()`
`static Health`	`healthy()` Creates a healthy status.
`static Health`	`hung(String reason)` Creates a hung status.
`static Health`	`initializing()` Creates an initializing status.
`boolean`	`isCritical()` Returns whether critical or not.
`boolean`	`isHealthy()` Returns whether healthy or not.
`boolean`	`isHung()` Returns whether hung (not responding) or not.
`boolean`	`isInitializing()` Returns whether initializing or not.
`boolean`	`isUnhealthy()` Returns whether unhealthy or critical or not.
`String`	`toString()`
`static Health`	`unhealthy(String reason)` Creates an unhealthy status.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - healthy
```
public static Health healthy()
```
    Creates a healthy status.
    
    Returns:
    a healthy status.
  - unhealthy
```
public static Health unhealthy(String reason)
```
    Creates an unhealthy status. An unhealthy status specifies a degraded condition, but the component that reports the unhealthy status is still functional.
    
    Parameters:
    reason - reason why unhealthy.
    
    Returns:
    an unhealthy status
  - critical
```
public static Health critical(String reason)
```
    Creates a critical status. A critical status specifies a condition that usually requires immediate attention.
    
    Parameters:
    reason - reason why critical
    
    Returns:
    a critical status
  - hung
```
public static Health hung(String reason)
```
    Creates a hung status. A hung status specifies a condition that usually requires immediate attention. This status indicates the request to check the monitorable's health status is not returning.
    
    Parameters:
    reason - reason why critical
    
    Returns:
    a critical status
  - initializing
```
public static Health initializing()
```
    Creates an initializing status. Initializing means the health manager has not yet retrieved the monitorable's health state for the first time.
    
    Returns:
    an initializing status.
  - isHealthy
```
public boolean isHealthy()
```
    Returns whether healthy or not.
    
    Returns:
    true if healthy, false otherwise
  - isUnhealthy
```
public boolean isUnhealthy()
```
    Returns whether unhealthy or critical or not.
    
    Returns:
    true if unhealthy or critical, false otherwise
  - isCritical
```
public boolean isCritical()
```
    Returns whether critical or not.
    
    Returns:
    true if critical, false otherwise
  - isInitializing
```
public boolean isInitializing()
```
    Returns whether initializing or not.
    
    Returns:
    true if initializing, false otherwise
  - isHung
```
public boolean isHung()
```
    Returns whether hung (not responding) or not.
    
    Returns:
    true if hung, false otherwise
  - getHealthCode
```
public String getHealthCode()
```
    Returns a human-readable health code.
    
    Returns:
    health code
  - getHealthReason
```
public String getHealthReason()
```
    Returns the reason for the health of application.
    
    Returns:
    health reason
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Health

Method Summary

Methods inherited from class java.lang.Object

Method Detail

healthy

unhealthy

critical

hung

initializing

isHealthy

isUnhealthy

isCritical

isInitializing

isHung

getHealthCode

getHealthReason

equals

hashCode

toString