Package org.odpi.openmetadata.adapters.connectors.pasteur.controls

Enum Class PasteurConfigurationProperty

java.lang.Object
java.lang.Enum<PasteurConfigurationProperty>
org.odpi.openmetadata.adapters.connectors.pasteur.controls.PasteurConfigurationProperty
All Implemented Interfaces:
Serializable, Comparable<PasteurConfigurationProperty>, Constable
public enum PasteurConfigurationProperty extends Enum<PasteurConfigurationProperty>
PasteurConfigurationProperty provides definitions for the configuration properties used with the Pasteur Action History Cleanup integration connector.

  • Enum Constant Details

    • DAYS_TO_CLEAN_UP

      public static final PasteurConfigurationProperty DAYS_TO_CLEAN_UP
      The minimum number of days after completion before each type of action is deleted.

    • COMPLETION_STATUSES

      public static final PasteurConfigurationProperty COMPLETION_STATUSES
      The completion statuses that make an action eligible for clean-up.

    • DELETE_METHOD

      public static final PasteurConfigurationProperty DELETE_METHOD
      The delete method used to remove the finished actions.

  • Field Details

    • name

      public final String name

    • description

      public final String description

    • dataType

      public final String dataType

    • example

      public final String example

    • isPlaceholder

      public final boolean isPlaceholder

    • DEFAULT_COMPLETION_STATUSES

      public static final List<String> DEFAULT_COMPLETION_STATUSES
      The completion statuses used when the completionStatuses configuration property is not set.

  • Method Details

    • values

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

    • getDefaultDaysToCleanUp

      public static Map<String,Long> getDefaultDaysToCleanUp()
      Return the days to clean up set by the core content pack. The engine actions are the bulk of the action history, and each has served its purpose once the steward has seen that it has finished, so they go after a week. A governance action process instance anchors the engine actions it ran, and deleting it removes them too, so it is kept for a little longer to give a complete picture of each recent process. To dos are created and finished by people, so they are kept for a quarter. The other types of action, such as meetings, notifications and reviews, are kept until someone adds them.
      Returns:
      map of type name to days

    • getName

      public String getName()
      Return the name of the configuration property.
      Returns:
      string name

    • getDescription

      public String getDescription()
      Return the description of the configuration property.
      Returns:
      string description

    • getDataType

      public String getDataType()
      Return the data type for the configuration property.
      Returns:
      string data type name

    • getExample

      public String getExample()
      Return an example of the configuration property to help users understand how to set it up.
      Returns:
      string example

    • isPlaceholder

      public boolean isPlaceholder()
      Return whether this value is also used as a placeholder property.
      Returns:
      boolean

    • getConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getConfigurationPropertyTypes()
      Retrieve the defined configuration properties as a list of the type used in the connector's specification.
      Returns:
      list

    • getConfigurationPropertyType

      public ConfigurationPropertyType getConfigurationPropertyType()
      Return a summary of this enum to use in the connector's specification.
      Returns:
      configuration property type

    • toString

      public String toString()
      Output of this enum class and main value.
      Overrides:
      toString in class Enum<PasteurConfigurationProperty>
      Returns:
      string showing enum value