Package org.odpi.openmetadata.adapters.connectors.integration.jdbc.controls

Enum Class JDBCConfigurationProperty

java.lang.Object
java.lang.Enum<JDBCConfigurationProperty>
org.odpi.openmetadata.adapters.connectors.integration.jdbc.controls.JDBCConfigurationProperty
All Implemented Interfaces:
Serializable, Comparable<JDBCConfigurationProperty>, Constable
public enum JDBCConfigurationProperty extends Enum<JDBCConfigurationProperty>
JDBCConfigurationProperty provides definitions for the configuration properties used with the JDBC Integration Connector.

  • Enum Constant Details

    • CATALOG

      public static final JDBCConfigurationProperty CATALOG
      An optional property used to provide a display name to a new database asset created by this connector.

    • INCLUDE_SCHEMA_NAMES

      public static final JDBCConfigurationProperty INCLUDE_SCHEMA_NAMES
      Provide a comma-separated list of schema names that should be catalogued. Other schemas will be ignored.

    • EXCLUDE_SCHEMA_NAMES

      public static final JDBCConfigurationProperty EXCLUDE_SCHEMA_NAMES
      Provide a comma-separated list of schema names that should not be catalogued. Only schemas not in this list will be catalogued.

    • INCLUDE_TABLE_NAMES

      public static final JDBCConfigurationProperty INCLUDE_TABLE_NAMES
      Provide a comma-separated list of table names that should be catalogued. Other tables will be ignored.

    • EXCLUDE_TABLE_NAMES

      public static final JDBCConfigurationProperty EXCLUDE_TABLE_NAMES
      Provide a comma-separated list of table names that should not be catalogued. Only tables not in this list will be catalogued.

    • INCLUDE_VIEW_NAMES

      public static final JDBCConfigurationProperty INCLUDE_VIEW_NAMES
      Provide a comma-separated list of view names that should be catalogued. Other views will be ignored.

    • EXCLUDE_VIEW_NAMES

      public static final JDBCConfigurationProperty EXCLUDE_VIEW_NAMES
      Provide a comma-separated list of view names that should not be catalogued. Only views not in this list will be catalogued.

    • INCLUDE_COLUMN_NAMES

      public static final JDBCConfigurationProperty INCLUDE_COLUMN_NAMES
      Provide a comma-separated list of column names that should be catalogued. Other columns will be ignored.

    • EXCLUDE_COLUMN_NAMES

      public static final JDBCConfigurationProperty EXCLUDE_COLUMN_NAMES
      Provide a comma-separated list of column names that should not be catalogued. Only columns not in this list will be catalogued.

  • Field Details

    • name

      public final String name

    • description

      public final String description

    • dataType

      public final String dataType

    • example

      public final String example

    • isRequired

      public final boolean isRequired

  • Method Details

    • values

      public static JDBCConfigurationProperty[] 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 JDBCConfigurationProperty 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 request parameter.
      Returns:
      string name

    • getDescription

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

    • getDataType

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

    • getExample

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

    • isRequired

      public boolean isRequired()
      Return whether this value is required.
      Returns:
      boolean

    • getConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getConfigurationPropertyTypes()
      Retrieve all the defined configuration properties
      Returns:
      list of configuration property types

    • getRecognizedConfigurationProperties

      public static List<String> getRecognizedConfigurationProperties()
      Retrieve all the defined configuration property names
      Returns:
      list of configuration property types

    • getConfigurationPropertyType

      public ConfigurationPropertyType getConfigurationPropertyType()
      Return a summary of this enum to use in a connector provider.
      Returns:
      request parameter type

    • toString

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