Package org.odpi.openmetadata.adapters.connectors.apacheatlas.survey.controls

Enum Class AtlasRequestParameter

java.lang.Object
java.lang.Enum<AtlasRequestParameter>
org.odpi.openmetadata.adapters.connectors.apacheatlas.survey.controls.AtlasRequestParameter
All Implemented Interfaces:
Serializable, Comparable<AtlasRequestParameter>, Constable
public enum AtlasRequestParameter extends Enum<AtlasRequestParameter>
RequestParameter provides some standard definitions for request parameters used to pass properties to governance actions when they run. Using standard names for request parameters wherever necessary helps to simplify the integration of governance services.

  • Enum Constant Details

  • 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 AtlasRequestParameter[] 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 AtlasRequestParameter 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 request parameter.
      Returns:
      text

    • getDataType

      public String getDataType()
      Return the data type for the request parameter.
      Returns:
      data type name

    • getExample

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

    • getRequestParameterTypes

      public static List<RequestParameterType> getRequestParameterTypes()
      Retrieve all the defined request parameters
      Returns:
      list of request parameter types

    • getRequestParameterType

      public RequestParameterType getRequestParameterType()
      Return a summary of this enum to use in a service provider.
      Returns:
      request parameter type

    • toString

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