Package org.odpi.openmetadata.governanceservers.enginehostservices.properties

Enum Class GovernanceEngineStatus

java.lang.Object

java.lang.Enum<GovernanceEngineStatus>

org.odpi.openmetadata.governanceservers.enginehostservices.properties.GovernanceEngineStatus

All Implemented Interfaces:

Serializable, Comparable<GovernanceEngineStatus>, Constable

public enum GovernanceEngineStatus
extends Enum<GovernanceEngineStatus>

GovernanceEngineStatus defines the status of a governance engine.

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
ASSIGNED	The governance engine is assigned to the engine host server but has not yet been configured.
CONFIGURING	The governance engine is retrieving its configuration from the metadata server.
DISABLED	The governance engine has been disabled.
FAILED	The governance engine is unable to run successfully due to an error in its configuration.
RUNNING	The governance engine is operational and able to service all defined governance requests on demand.

Method Summary

Modifier and Type	Method	Description
int	getOrdinal()	Return the code for this enum instance
String	getStatusDescription()	Return the default description for the type for this enum instance.
String	getStatusName()	Return the default name for this enum instance.
static GovernanceEngineStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GovernanceEngineStatus[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASSIGNED

public static final GovernanceEngineStatus ASSIGNED

The governance engine is assigned to the engine host server but has not yet been configured.

CONFIGURING

public static final GovernanceEngineStatus CONFIGURING

The governance engine is retrieving its configuration from the metadata server.

RUNNING

public static final GovernanceEngineStatus RUNNING

The governance engine is operational and able to service all defined governance requests on demand.

FAILED

public static final GovernanceEngineStatus FAILED

The governance engine is unable to run successfully due to an error in its configuration.

DISABLED

public static final GovernanceEngineStatus DISABLED

The governance engine has been disabled. It is waiting to be enabled before it can service any more governance requests.

Method Details

values

public static GovernanceEngineStatus[] 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 GovernanceEngineStatus 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

getOrdinal

public int getOrdinal()

Return the code for this enum instance

Returns:

int type code

getStatusName

public String getStatusName()

Return the default name for this enum instance.

Returns:

String default name

getStatusDescription

public String getStatusDescription()

Return the default description for the type for this enum instance.

Returns:

String default description