Package org.odpi.openmetadata.frameworks.openwatchdog.controls

Enum Class WatchdogActionGuard

java.lang.Object

java.lang.Enum<WatchdogActionGuard>

org.odpi.openmetadata.frameworks.openwatchdog.controls.WatchdogActionGuard

All Implemented Interfaces:

Serializable, Comparable<WatchdogActionGuard>, Constable

public enum WatchdogActionGuard
extends Enum<WatchdogActionGuard>

The WatchdogActionGuard enum describes the standard guards that are automatically set up for all watchdog action services.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MONITORING_COMPLETED
MONITORING_FAILED
MONITORING_INVALID

Field Summary

Fields

Modifier and Type	Field	Description
final CompletionStatus	completionStatus
final String	description
final String	name

Method Summary

Modifier and Type	Method	Description
CompletionStatus	getCompletionStatus()	Return the typical completion status used with this guard.
String	getDescription()	Return the description of the guard.
GuardType	getGuardType()	Return the details of a specific guard.
String	getName()	Return the name of the guard.
static List<GuardType>	getSimpleWatchdogGuardTypes()	Return details of the guards used on a simple survey.
String	toString()	Output of this enum class and main value.
static WatchdogActionGuard	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WatchdogActionGuard[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MONITORING_COMPLETED

public static final WatchdogActionGuard MONITORING_COMPLETED

MONITORING_INVALID

public static final WatchdogActionGuard MONITORING_INVALID

MONITORING_FAILED

public static final WatchdogActionGuard MONITORING_FAILED

Field Details

name

public final String name

completionStatus

public final CompletionStatus completionStatus

description

public final String description

Method Details

values

public static WatchdogActionGuard[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static WatchdogActionGuard valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Return the name of the guard.

Returns:

string name

getCompletionStatus

public CompletionStatus getCompletionStatus()

Return the typical completion status used with this guard.

Returns:

completion status

getDescription

public String getDescription()

Return the description of the guard.

Returns:

text

getSimpleWatchdogGuardTypes

public static List<GuardType> getSimpleWatchdogGuardTypes()

Return details of the guards used on a simple survey. These guards are set automatically if the survey does not set a guard itself.

Returns:

guard types

getGuardType

public GuardType getGuardType()

Return the details of a specific guard.

Returns:

guard type

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<WatchdogActionGuard>

Returns:

string showing enum value