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

Enum Class PepysConfigurationProperty

java.lang.Object
java.lang.Enum<PepysConfigurationProperty>
org.odpi.openmetadata.adapters.connectors.pepys.controls.PepysConfigurationProperty
All Implemented Interfaces:
Serializable, Comparable<PepysConfigurationProperty>, Constable
public enum PepysConfigurationProperty extends Enum<PepysConfigurationProperty>
PepysConfigurationProperty provides definitions for the configuration properties used with the Pepys Activity Observer.

  • Enum Constant Details

    • IGNORED_USER_ID_PATTERNS

      public static final PepysConfigurationProperty IGNORED_USER_ID_PATTERNS
      The patterns that match the userIds whose activity is not counted.

  • 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_IGNORED_USER_ID_PATTERNS

      public static final List<String> DEFAULT_IGNORED_USER_ID_PATTERNS
      The patterns set up by the core content pack: the non-personal accounts of the OMAG servers and integration connectors (ending in npa) and the governance engines (ending in engine).

  • Method Details

    • values

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