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

Enum Class UnityCatalogTemplateType

java.lang.Object
java.lang.Enum<UnityCatalogTemplateType>
org.odpi.openmetadata.adapters.connectors.unitycatalog.controls.UnityCatalogTemplateType
All Implemented Interfaces:
Serializable, Comparable<UnityCatalogTemplateType>, Constable
public enum UnityCatalogTemplateType extends Enum<UnityCatalogTemplateType>
TemplateTypeEnum characterises the type of templates supported by an integration connector. It should be copied by developers of an integration connector to help populate the supportedTemplates property of its provider.

  • Enum Constant Details

  • Method Details

    • values

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

    • getTemplateName

      public String getTemplateName()
      Return the name of the template.
      Returns:
      name

    • getTemplateDescription

      public String getTemplateDescription()
      Return the description of the template, such as its content.
      Returns:
      description

    • getTypeName

      public String getTypeName()
      Return the open metadata type name.
      Returns:
      open metadata type name

    • getRequired

      public boolean getRequired()
      Return whether this catalog template is required for this service to work successful.
      Returns:
      boolean flag

    • getDefaultTemplateGUID

      public String getDefaultTemplateGUID()
      Return the unique identifier of the default template to use with this connector - this is optional.
      Returns:
      string

    • getOtherPropertyValues

      public Map<String,String> getOtherPropertyValues()
      Return a map of property name to property value that the catalog template should have to be valid for this integration connector.
      Returns:
      map of string to string

    • getTemplateTypes

      public static List<org.odpi.openmetadata.frameworks.connectors.controls.TemplateType> getTemplateTypes()
      Return all the template types defined by this enum.
      Returns:
      list of catalog template type

    • getInsideCatalogTemplateTypes

      public static List<org.odpi.openmetadata.frameworks.connectors.controls.TemplateType> getInsideCatalogTemplateTypes()
      Return all the template types defined by this enum.
      Returns:
      list of catalog template type

    • getTemplateType

      public org.odpi.openmetadata.frameworks.connectors.controls.TemplateType getTemplateType()
      Return the catalog template type for a specific catalog template enum.
      Returns:
      catalog template type

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<UnityCatalogTemplateType>
      Returns:
      return string containing the property names and values