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

Enum Class PostgresConfigurationProperty

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

  • Enum Constant Details

    • HOST_IDENTIFIER

      public static final PostgresConfigurationProperty HOST_IDENTIFIER
      The host IP address or domain name of the database server.

    • PORT_NUMBER

      public static final PostgresConfigurationProperty PORT_NUMBER
      The number of the port to use to connect to the database server.

    • SERVER_NAME

      public static final PostgresConfigurationProperty SERVER_NAME
      The name of the database server being catalogued.

    • DATABASE_NAME

      public static final PostgresConfigurationProperty DATABASE_NAME
      The name of the database being catalogued.

    • DATABASE_USER_ID

      public static final PostgresConfigurationProperty DATABASE_USER_ID
      The userId to store in the userId attribute of the connection.

    • DATABASE_PASSWORD

      public static final PostgresConfigurationProperty DATABASE_PASSWORD
      The password to store in the clearPassword attribute of the connection.

    • SCHEMA_NAME

      public static final PostgresConfigurationProperty SCHEMA_NAME
      The name of the database schema being catalogued.

    • TABLE_NAME

      public static final PostgresConfigurationProperty TABLE_NAME
      The name of the database table being catalogued.

    • DATABASE_CATALOG_TEMPLATE_QUALIFIED_NAME

      public static final PostgresConfigurationProperty DATABASE_CATALOG_TEMPLATE_QUALIFIED_NAME
      Provides a list of database names that should not be catalogued.

    • EXCLUDE_DATABASE_LIST

      public static final PostgresConfigurationProperty EXCLUDE_DATABASE_LIST
      Provides a list of database names that should not be catalogued.

    • INCLUDE_DATABASE_LIST

      public static final PostgresConfigurationProperty INCLUDE_DATABASE_LIST
      Provides a list of databases that should be catalogued. If not set, or null, or *, all databases except the excluded databases are catalogued.

  • 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

  • Method Details

    • values

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

    • isPlaceholder

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

    • getPostgresServerIntegrationConnectorNames

      public static List<String> getPostgresServerIntegrationConnectorNames()
      Get recognizedConfigurationProperties for the PostgreSQLServer Integration connector.
      Returns:
      list of property names

    • getPostgresServerConfigurationPropertyTypes

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

    • getConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getConfigurationPropertyTypes()
      Retrieve all the defined configuration properties
      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<PostgresConfigurationProperty>
      Returns:
      string showing enum value