Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class EngineActionStatus

java.lang.Object

java.lang.Enum<EngineActionStatus>

org.odpi.openmetadata.frameworks.openmetadata.enums.EngineActionStatus

All Implemented Interfaces:

Serializable, Comparable<EngineActionStatus>, Constable, OpenMetadataEnum

public enum EngineActionStatus
extends Enum<EngineActionStatus>
implements OpenMetadataEnum

EngineActionStatus defines the current status for a engine action.

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
ACTIONED	The governance service for the engine action has successfully completed processing.
ACTIVATING	The governance service for the engine action is being initialized in the governance engine.
APPROVED	The engine action is approved to run.
CANCELLED	The engine action was cancelled by an external caller.
FAILED	The governance service for the engine action failed to execute.
IGNORED	The engine action has not been run because a different engine action was chosen.
IN_PROGRESS	The governance engine is running the associated governance service for the engine action.
INVALID	The engine action has not been run because it is not appropriate (for example, a false positive).
OTHER	Undefined or unknown engine action status.
REQUESTED	The engine action has been created and is pending.
WAITING	The engine action is waiting for its start time or the engine host to claim it.

Method Summary

Modifier and Type	Method	Description
String	getCategory()	Return the category for this value.
String	getDescription()	Return the default description of the enumeration.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name of the enumeration.
static String	getOpenTypeDescription()	Return the description for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionGUID()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionWiki()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
static String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOrdinal()	Return the numeric representation of the enumeration.
String	getQualifiedName()	Return the qualified name for this value.
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	Standard toString method.
static EngineActionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EngineActionStatus[]	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

REQUESTED

public static final EngineActionStatus REQUESTED

The engine action has been created and is pending.

APPROVED

public static final EngineActionStatus APPROVED

The engine action is approved to run. This means that the mandatory guards have been satisfied.

WAITING

public static final EngineActionStatus WAITING

The engine action is waiting for its start time or the engine host to claim it.

ACTIVATING

public static final EngineActionStatus ACTIVATING

The governance service for the engine action is being initialized in the governance engine.

IN_PROGRESS

public static final EngineActionStatus IN_PROGRESS

The governance engine is running the associated governance service for the engine action.

ACTIONED

public static final EngineActionStatus ACTIONED

The governance service for the engine action has successfully completed processing.

INVALID

public static final EngineActionStatus INVALID

The engine action has not been run because it is not appropriate (for example, a false positive).

IGNORED

public static final EngineActionStatus IGNORED

The engine action has not been run because a different engine action was chosen.

FAILED

public static final EngineActionStatus FAILED

The governance service for the engine action failed to execute.

CANCELLED

public static final EngineActionStatus CANCELLED

The engine action was cancelled by an external caller.

OTHER

public static final EngineActionStatus OTHER

Undefined or unknown engine action status.

Method Details

values

public static EngineActionStatus[] 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 EngineActionStatus 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 numeric representation of the enumeration.

Specified by:

getOrdinal in interface OpenMetadataEnum

Returns:

int ordinal

getName

public String getName()

Return the default name of the enumeration.

Specified by:

getName in interface OpenMetadataEnum

Returns:

String name

getDescription

public String getDescription()

Return the default description of the enumeration.

Specified by:

getDescription in interface OpenMetadataEnum

Returns:

String description

getDescriptionGUID

public String getDescriptionGUID()

Return the unique identifier for the valid value that represents the enum value.

Specified by:

getDescriptionGUID in interface OpenMetadataEnum

Returns:

guid

isDefault

public boolean isDefault()

Return whether the enum is the default value or not.

Specified by:

isDefault in interface OpenMetadataEnum

Returns:

boolean

getOpenTypeGUID

public static String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public static String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

getOpenTypeDescription

public static String getOpenTypeDescription()

Return the description for the open metadata enum type that this enum class represents.

Returns:

string description

getOpenTypeDescriptionGUID

public static String getOpenTypeDescriptionGUID()

Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeDescriptionWiki

public static String getOpenTypeDescriptionWiki()

Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.

Returns:

string guid

getQualifiedName

public String getQualifiedName()

Return the qualified name for this value.

Returns:

string

getCategory

public String getCategory()

Return the category for this value.

Returns:

string

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<EngineActionStatus>

Returns:

print out of variables in a JSON-style