Package org.odpi.openmetadata.adapters.connectors.apacheatlas.control

Enum Class AtlasPlaceholderProperty

java.lang.Object
java.lang.Enum<AtlasPlaceholderProperty>
org.odpi.openmetadata.adapters.connectors.apacheatlas.control.AtlasPlaceholderProperty
All Implemented Interfaces:
Serializable, Comparable<AtlasPlaceholderProperty>, Constable
public enum AtlasPlaceholderProperty extends Enum<AtlasPlaceholderProperty>
PlaceholderProperty provides some standard definitions for placeholder properties used to pass properties to services that use templates.

  • Enum Constant Details

    • HOST_IDENTIFIER

      public static final AtlasPlaceholderProperty HOST_IDENTIFIER
      The host IP address or domain name.

    • PORT_NUMBER

      public static final AtlasPlaceholderProperty PORT_NUMBER
      The number of the port to use to connect to a service.

    • CONNECTION_USER_ID

      public static final AtlasPlaceholderProperty CONNECTION_USER_ID
      The userId to store in the userId attribute of the connection.

    • CONNECTION_PASSWORD

      public static final AtlasPlaceholderProperty CONNECTION_PASSWORD
      The password to store in the clearPassword attribute of the connection.

    • SERVER_NAME

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

  • Field Details

    • name

      public final String name

    • description

      public final String description

    • dataType

      public final String dataType

    • example

      public final String example

  • Method Details

    • values

      public static AtlasPlaceholderProperty[] 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 AtlasPlaceholderProperty 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 placeholder property.
      Returns:
      string name

    • getPlaceholder

      public String getPlaceholder()
      Return the placeholder to use when building templates.
      Returns:
      placeholder property

    • getDescription

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

    • getDataType

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

    • getExample

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

    • getPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties
      Returns:
      list of placeholder property types

    • getPlaceholderType

      public PlaceholderPropertyType getPlaceholderType()
      Return a summary of this enum to use in a service provider.
      Returns:
      placeholder property type

    • toString

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