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

Enum Class DarwinConfigurationProperty

java.lang.Object
java.lang.Enum<DarwinConfigurationProperty>
org.odpi.openmetadata.adapters.connectors.darwin.controls.DarwinConfigurationProperty
All Implemented Interfaces:
Serializable, Comparable<DarwinConfigurationProperty>, Constable
public enum DarwinConfigurationProperty extends Enum<DarwinConfigurationProperty>
DarwinConfigurationProperty provides definitions for the configuration properties used with the Darwin Product Dependency Manager.

  • Enum Constant Details

    • MAX_LINEAGE_DEPTH

      public static final DarwinConfigurationProperty MAX_LINEAGE_DEPTH
      The maximum number of lineage relationships that are followed downstream from an asset that is a member of a digital product before the search for a dependent product is abandoned.

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

      public static final int DEFAULT_MAX_LINEAGE_DEPTH
      The default maximum number of lineage relationships followed downstream from a product's asset.
      See Also:

  • Method Details

    • values

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