Package org.odpi.openmetadata.frameworks.openmetadata.controls

Enum Class PlaceholderProperty

java.lang.Object
java.lang.Enum<PlaceholderProperty>
org.odpi.openmetadata.frameworks.openmetadata.controls.PlaceholderProperty
All Implemented Interfaces:
Serializable, Comparable<PlaceholderProperty>, Constable
public enum PlaceholderProperty extends Enum<PlaceholderProperty>
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 PlaceholderProperty HOST_IDENTIFIER
      The host IP address or domain name.

    • HOST_URL

      public static final PlaceholderProperty HOST_URL
      The host IP address or domain name.

    • PORT_NUMBER

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

    • SERVER_NETWORK_ADDRESS

      public static final PlaceholderProperty SERVER_NETWORK_ADDRESS
      The network address of the server

    • API_OPERATION

      public static final PlaceholderProperty API_OPERATION
      The name of the operation to append onto the server host name/port number, or set it to an empty string if not needed.

    • CONNECTION_USER_ID

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

    • SERVER_NAME

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

    • SERVER_ID

      public static final PlaceholderProperty SERVER_ID
      The name of the server being catalogued.

    • SCHEMA_NAME

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

    • DISPLAY_NAME

      public static final PlaceholderProperty DISPLAY_NAME
      The display name is used to identify the element.

    • DESCRIPTION

      public static final PlaceholderProperty DESCRIPTION
      The description of the element to help a consumer understand its content and purpose.

    • VERSION_IDENTIFIER

      public static final PlaceholderProperty VERSION_IDENTIFIER
      The description of the element to help a consumer understand its content and purpose.

    • SECRETS_STORE

      public static final PlaceholderProperty SECRETS_STORE
      The description of the element to help a consumer understand its content and purpose.

    • FORMULA

      public static final PlaceholderProperty FORMULA
      The formula used to populate the data set.

    • FORMULA_TYPE

      public static final PlaceholderProperty FORMULA_TYPE
      The language/format used in the data set's formula.

    • FILE_SYSTEM_NAME

      public static final PlaceholderProperty FILE_SYSTEM_NAME
      The full pathname of the file including the directory names, file name and file extension.

    • FORMAT

      public static final PlaceholderProperty FORMAT
      The format standard used in the file system.

    • ENCRYPTION

      public static final PlaceholderProperty ENCRYPTION
      Is encryption enabled on this file system? If known, what type of encryption?

    • DIRECTORY_PATH_NAME

      public static final PlaceholderProperty DIRECTORY_PATH_NAME
      The full pathname of the file including the directory names, file name and file extension.

    • DIRECTORY_NAME

      public static final PlaceholderProperty DIRECTORY_NAME
      The name of the leaf directory, without its enclosing directories.

    • FILE_PATH_NAME

      public static final PlaceholderProperty FILE_PATH_NAME
      The full pathname of the file including the directory names, file name and file extension.

    • FILE_NAME

      public static final PlaceholderProperty FILE_NAME
      The short name of the file with its extension but without the directory names.

    • FILE_TYPE

      public static final PlaceholderProperty FILE_TYPE
      The logical file type of the file.

    • FILE_EXTENSION

      public static final PlaceholderProperty FILE_EXTENSION
      The postfix identifier in the file name that indicates the format of the file.

    • FILE_ENCODING

      public static final PlaceholderProperty FILE_ENCODING
      The encoding scheme used on the file.

    • PROGRAMMING_LANGUAGE

      public static final PlaceholderProperty PROGRAMMING_LANGUAGE
      The programming language used to encode the file.

    • EMBEDDED_METADATA

      public static final PlaceholderProperty EMBEDDED_METADATA
      Descriptive metadata values embedded within the file.

    • CREATION_DATE

      public static final PlaceholderProperty CREATION_DATE
      The date that the file was created.

    • LAST_UPDATE_DATE

      public static final PlaceholderProperty LAST_UPDATE_DATE
      The date that the file was created.

    • LAST_ACCESSED_DATE

      public static final PlaceholderProperty LAST_ACCESSED_DATE

    • RECEIVED_DATE

      public static final PlaceholderProperty RECEIVED_DATE
      The date/time that the data/resource was received.

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

    • getHostPlaceholderPropertyTypes

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

    • getHTTPEndpointPlaceholderPropertyTypes

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

    • getServerWithUserIdOnlyPlaceholderPropertyTypes

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

    • getSecretServerPlaceholderPropertyTypes

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

    • getFileSystemPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getFileSystemPlaceholderPropertyTypes()
      Retrieve the Kafka Topic defined placeholder properties
      Returns:
      list of placeholder property types

    • getDataStorePlaceholderPropertyTypes

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

    • getDataSetPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getDataSetPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for directories (file folder)
      Returns:
      list of placeholder property types

    • getDataFilesPlaceholderPropertyTypes

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

    • getMediaFilesPlaceholderPropertyTypes

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

    • getFolderPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getFolderPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for directories (file folder)
      Returns:
      list of placeholder property types

    • getSoftwareFilesPlaceholderPropertyTypes

      public static List<PlaceholderPropertyType> getSoftwareFilesPlaceholderPropertyTypes()
      Retrieve all the defined placeholder properties for files associated with software
      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<PlaceholderProperty>
      Returns:
      string showing enum value