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

Enum Class FileSystemConfigurationProperty

java.lang.Object
java.lang.Enum<FileSystemConfigurationProperty>
org.odpi.openmetadata.frameworks.openmetadata.controls.FileSystemConfigurationProperty
All Implemented Interfaces:
Serializable, Comparable<FileSystemConfigurationProperty>, Constable
public enum FileSystemConfigurationProperty extends Enum<FileSystemConfigurationProperty>
FileSystemConfigurationProperty provides definitions for the configuration properties used to pass informaiton about the local file system.

  • Enum Constant Details

    • FILE_SYSTEM_NAME

      public static final FileSystemConfigurationProperty FILE_SYSTEM_NAME
      The logical name of the physical file system. This may be different from the file system retrieved by a program since files can be mounted at different points.

    • LOCAL_MOUNT_POINT

      public static final FileSystemConfigurationProperty LOCAL_MOUNT_POINT
      The root part of the path name that is defined by the mount point.

    • CANONICAL_MOUNT_POINT

      public static final FileSystemConfigurationProperty CANONICAL_MOUNT_POINT
      The character used to use as the quote character

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

    • getAllConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getAllConfigurationPropertyTypes()
      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<FileSystemConfigurationProperty>
      Returns:
      string showing enum value