Package org.odpi.openmetadata.frameworks.governanceaction.controls

Enum Class Guard

java.lang.Object
java.lang.Enum<Guard>
org.odpi.openmetadata.frameworks.governanceaction.controls.Guard
All Implemented Interfaces:
Serializable, Comparable<Guard>, Constable
public enum Guard extends Enum<Guard>
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

    • SERVICE_COMPLETED

      public static final Guard SERVICE_COMPLETED
      The service completed successfully.

    • SERVICE_FAILED

      public static final Guard SERVICE_FAILED
      An unexpected error occurred while the governance service was running. Messages are logged to the audit log explaining the source of the error.

    • INVALID_ACTION_TARGET_TYPE

      public static final Guard INVALID_ACTION_TARGET_TYPE
      One or all of the action targets passed to this service are not of the correct type and so the service has failed to start.

    • NO_TARGETS_DETECTED

      public static final Guard NO_TARGETS_DETECTED
      There is no supplied action target and so the governance service does not know which asset to work on.

    • TARGET_NOT_ASSET

      public static final Guard TARGET_NOT_ASSET
      The action target is not an asset.

    • MULTIPLE_TARGETS_DETECTED

      public static final Guard MULTIPLE_TARGETS_DETECTED
      Multiple action targets supplied. This governance service does not support multiple action targets because the result of the origin search could be different for each action target making it difficult to automate the response.

  • Field Details

    • name

      public final String name

    • completionStatus

      public final CompletionStatus completionStatus

    • description

      public final String description

  • Method Details

    • values

      public static Guard[] 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 Guard 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<Guard>
      Returns:
      string showing enum value