Package org.odpi.openmetadata.adapters.connectors.governanceactions.watchdog

Enum Class GenericWatchdogGuard

java.lang.Object
java.lang.Enum<GenericWatchdogGuard>
org.odpi.openmetadata.adapters.connectors.governanceactions.watchdog.GenericWatchdogGuard
All Implemented Interfaces:
Serializable, Comparable<GenericWatchdogGuard>, Constable
public enum GenericWatchdogGuard extends Enum<GenericWatchdogGuard>
The Guard enum describes some common guards that can be used when implementing governance services. Using the common guard names where possible saves time when coding the provider class and improves the ability of the service to be incorporated into governance action processes.

  • Enum Constant Details

  • Field Details

    • name

      public final String name

    • completionStatus

      public final CompletionStatus completionStatus

    • description

      public final String description

  • Method Details

    • values

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

    • getGuardTypes

      public static List<GuardType> getGuardTypes()
      Return details of all defined guards.
      Returns:
      guard types

    • getGuardType

      public GuardType getGuardType()
      Return 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<GenericWatchdogGuard>
      Returns:
      string showing enum value