Enum Class EngineActionStatus

java.lang.Object
java.lang.Enum<EngineActionStatus>
org.odpi.openmetadata.frameworks.governanceaction.properties.EngineActionStatus
All Implemented Interfaces:
Serializable, Comparable<EngineActionStatus>, Constable

public enum EngineActionStatus extends Enum<EngineActionStatus>
EngineActionStatus defines the current status for a governance 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
    The governance action service for the governance action has successfully completed processing.
    The governance action service for the governance action is being initialized in the governance engine.
    The governance action is approved to run.
    The governance action service for the governance action failed to execute.
    The governance action has not been run because a different governance action was chosen.
    The governance engine is running the associated governance action service for the governance action.
    The governance action has not been run because it is not appropriate (for example, a false positive).
    Undefined or unknown governance action status.
    The governance action has been created and is pending.
    The governance action is waiting for its start time or the right conditions to run.
  • Method Summary

    Modifier and Type
    Method
    Description
    Return the default description for the status for this enum instance.
    Return the default name for the status for this enum instance.
    Return the unique identifier for the open metadata enum type that this enum class represents.
    Return the unique name for the open metadata enum type that this enum class represents.
    int
    Return the code for this enum that comes from the Open Metadata Type that this enum represents.
    int
    Return the status code for this enum instance
    Standard toString method.
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • REQUESTED

      public static final EngineActionStatus REQUESTED
      The governance action has been created and is pending.
    • APPROVED

      public static final EngineActionStatus APPROVED
      The governance action is approved to run.
    • WAITING

      public static final EngineActionStatus WAITING
      The governance action is waiting for its start time or the right conditions to run.
    • ACTIVATING

      public static final EngineActionStatus ACTIVATING
      The governance action service for the governance action is being initialized in the governance engine.
    • IN_PROGRESS

      public static final EngineActionStatus IN_PROGRESS
      The governance engine is running the associated governance action service for the governance action.
    • ACTIONED

      public static final EngineActionStatus ACTIONED
      The governance action service for the governance action has successfully completed processing.
    • INVALID

      public static final EngineActionStatus INVALID
      The governance action has not been run because it is not appropriate (for example, a false positive).
    • IGNORED

      public static final EngineActionStatus IGNORED
      The governance action has not been run because a different governance action was chosen.
    • FAILED

      public static final EngineActionStatus FAILED
      The governance action service for the governance action failed to execute.
    • OTHER

      public static final EngineActionStatus OTHER
      Undefined or unknown governance 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 status code for this enum instance
      Returns:
      int status code
    • getName

      public String getName()
      Return the default name for the status for this enum instance.
      Returns:
      String default status name
    • getDescription

      public String getDescription()
      Return the default description for the status for this enum instance.
      Returns:
      String default status description
    • getOpenTypeOrdinal

      public int getOpenTypeOrdinal()
      Return the code for this enum that comes from the Open Metadata Type that this enum represents.
      Returns:
      int code number
    • getOpenTypeGUID

      public String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      Returns:
      string guid
    • getOpenTypeName

      public String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      Returns:
      string name
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<EngineActionStatus>
      Returns:
      print out of variables in a JSON-style