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

Enum Class UnityCatalogConfigurationProperty

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

  • Enum Constant Details

    • FRIENDSHIP_GUID

      public static final UnityCatalogConfigurationProperty FRIENDSHIP_GUID
      Unique identifier of the integration connector that is able to catalog the contents of a UC catalog.

    • INCLUDE_CATALOG_NAMES

      public static final UnityCatalogConfigurationProperty INCLUDE_CATALOG_NAMES
      Provide a comma-separated list of catalog names that should be catalogued. Other catalogs will be ignored.

    • EXCLUDE_CATALOG_NAMES

      public static final UnityCatalogConfigurationProperty EXCLUDE_CATALOG_NAMES
      Provide a comma-separated list of catalog names that should not be catalogued. Only catalog not in this list will be catalogued.

    • INCLUDE_SCHEMA_NAMES

      public static final UnityCatalogConfigurationProperty 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 UnityCatalogConfigurationProperty 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 UnityCatalogConfigurationProperty 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 UnityCatalogConfigurationProperty 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_FUNCTION_NAMES

      public static final UnityCatalogConfigurationProperty INCLUDE_FUNCTION_NAMES
      Provide a comma-separated list of function names that should be catalogued. Other functions will be ignored.

    • EXCLUDE_FUNCTION_NAMES

      public static final UnityCatalogConfigurationProperty EXCLUDE_FUNCTION_NAMES
      Provide a comma-separated list of function names that should not be catalogued. Only functions not in this list will be catalogued.

    • INCLUDE_VOLUME_NAMES

      public static final UnityCatalogConfigurationProperty INCLUDE_VOLUME_NAMES
      Provide a comma-separated list of volume names that should be catalogued. Other volumes will be ignored.

    • EXCLUDE_VOLUME_NAMES

      public static final UnityCatalogConfigurationProperty EXCLUDE_VOLUME_NAMES
      Provide a comma-separated list of volume names that should not be catalogued. Only volumes not in this list will be catalogued.

    • CATALOG_NAME

      public static final UnityCatalogConfigurationProperty CATALOG_NAME
      The name of the catalog being described.

    • SCHEMA_NAME

      public static final UnityCatalogConfigurationProperty SCHEMA_NAME
      The name of a schema within a catalog in Unity Catalog (UC).

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

    • getUnityCatalogServerRecognizedConfigurationProperties

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

    • getUnityCatalogServerConfigurationPropertyTypes

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

    • getUnityCatalogInsideCatalogRecognizedConfigurationProperties

      public static List<String> getUnityCatalogInsideCatalogRecognizedConfigurationProperties()
      Get recognizedConfigurationProperties for the UC Inside Catalog Integration connector.
      Returns:
      list of property names

    • getUnityCatalogInsideCatalogConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getUnityCatalogInsideCatalogConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the UC Inside Catalog integration connector.
      Returns:
      list of configuration property types

    • getUnityCatalogInsideCatalogSurveyRecognizedConfigurationProperties

      public static List<String> getUnityCatalogInsideCatalogSurveyRecognizedConfigurationProperties()
      Get recognizedConfigurationProperties for the UC Catalog Survey Service.
      Returns:
      list of property names

    • getUnityCatalogInsideCatalogSurveyConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getUnityCatalogInsideCatalogSurveyConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the UC Server Survey Service.
      Returns:
      list of configuration property types

    • getUnityCatalogInsideSchemaSurveyRecognizedConfigurationProperties

      public static List<String> getUnityCatalogInsideSchemaSurveyRecognizedConfigurationProperties()
      Get recognizedConfigurationProperties for the UC Catalog Survey Service.
      Returns:
      list of property names

    • getUnityCatalogInsideSchemaSurveyConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getUnityCatalogInsideSchemaSurveyConfigurationPropertyTypes()
      Retrieve the defined configuration properties for the UC Server Survey Service.
      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<UnityCatalogConfigurationProperty>
      Returns:
      string showing enum value