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

Enum Class MSSQLConfigurationProperty

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

  • Enum Constant Details

    • HOST_IDENTIFIER

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

    • PORT_NUMBER

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

    • SERVER_NAME

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

    • DATABASE_NAME

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

    • DATABASE_USER_ID

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

    • DATABASE_PASSWORD

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

    • SCHEMA_NAME

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

    • SCHEMA_DESCRIPTION

      public static final MSSQLConfigurationProperty SCHEMA_DESCRIPTION
      The description of the database schema being catalogued.

    • TABLE_NAME

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

    • TABLE_DESCRIPTION

      public static final MSSQLConfigurationProperty TABLE_DESCRIPTION
      The description of the database table being catalogued.

    • EXCLUDE_DATABASE_LIST

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

    • INCLUDE_DATABASE_LIST

      public static final MSSQLConfigurationProperty 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.

    • FRIENDSHIP_GUID

      public static final MSSQLConfigurationProperty FRIENDSHIP_GUID
      Unique identifier of the integration connector that is able to catalog the contents of a Microsoft SQL Server database.

  • 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 MSSQLConfigurationProperty[] 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 MSSQLConfigurationProperty 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

    • getMSSQLServerIntegrationConnectorNames

      public static List<String> getMSSQLServerIntegrationConnectorNames()
      Get recognizedConfigurationProperties for the Microsoft SQL Server Integration connector.
      Returns:
      list of property names

    • getMSSQLServerConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getMSSQLServerConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the Microsoft SQL Server integration connector.
      Returns:
      list of configuration property types

    • getMSSQLTabularDataSourceConfigPropertyNames

      public static List<String> getMSSQLTabularDataSourceConfigPropertyNames()
      Get recognizedConfigurationProperties for the Microsoft SQL Server tabular data source resource connector.
      Returns:
      list of property names

    • getMSSQLTabularDataSourceConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getMSSQLTabularDataSourceConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the Microsoft SQL Server tabular data source connector
      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<MSSQLConfigurationProperty>
      Returns:
      string showing enum value