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

Enum Class SurveyRequestParameter

java.lang.Object
java.lang.Enum<SurveyRequestParameter>
org.odpi.openmetadata.frameworks.opensurvey.controls.SurveyRequestParameter
All Implemented Interfaces:
Serializable, Comparable<SurveyRequestParameter>, Constable
public enum SurveyRequestParameter extends Enum<SurveyRequestParameter>
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

    • FINAL_ANALYSIS_STEP

      public static final SurveyRequestParameter FINAL_ANALYSIS_STEP
      The name of the last analysis step that the survey action service is to run. The survey stops once this step is complete. If the survey never reaches the named step, it runs to completion. The values that a survey action service supports are listed, in the order it runs them, in the validValues property of its finalAnalysisStep supported request parameter.

    • INCLUDE_SCHEMA_NAMES

      public static final SurveyRequestParameter INCLUDE_SCHEMA_NAMES
      Provides a list of schema names that should be surveyed. Other schemas are ignored. This takes precedence over the exclude list.

    • EXCLUDE_SCHEMA_NAMES

      public static final SurveyRequestParameter EXCLUDE_SCHEMA_NAMES
      Provides a list of schema names that should not be surveyed. Only schemas not in this list are surveyed.

  • 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 SurveyRequestParameter[] 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 SurveyRequestParameter 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(AnalysisStep[] finalAnalysisSteps)
      Retrieve the request parameters that every survey action service supports.
      Parameters:
      finalAnalysisSteps - the analysis steps that the survey action service can stop after, in the order it runs them; null if they are not known
      Returns:
      list of request parameter types

    • getSchemaSurveyRequestParameterTypes

      public static List<RequestParameterType> getSchemaSurveyRequestParameterTypes(AnalysisStep[] finalAnalysisSteps)
      Retrieve the request parameters supported by a survey action service that can be limited to some of the schemas it finds.
      Parameters:
      finalAnalysisSteps - the analysis steps that the survey action service can stop after, in the order it runs them; null if they are not known
      Returns:
      list of request parameter types

    • getFinalAnalysisStepType

      public static RequestParameterType getFinalAnalysisStepType(AnalysisStep[] finalAnalysisSteps)
      Return the description of the finalAnalysisStep request parameter for a particular survey action service. The analysis steps it can stop after are listed in the validValues property, separated by commas, so that a caller can discover them from the service's specification.
      Parameters:
      finalAnalysisSteps - the analysis steps that the survey action service can stop after, in the order it runs them; null if they are not known
      Returns:
      request parameter type

    • getFinalAnalysisStepConfigurationPropertyType

      public static ConfigurationPropertyType getFinalAnalysisStepConfigurationPropertyType(AnalysisStep[] finalAnalysisSteps)
      Return the description of the finalAnalysisStep configuration property for a particular survey action service. It sets the final analysis step for every survey the service runs, unless a request overrides it with the request parameter of the same name.
      Parameters:
      finalAnalysisSteps - the analysis steps that the survey action service can stop after, in the order it runs them; null if they are not known
      Returns:
      configuration property type

    • 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<SurveyRequestParameter>
      Returns:
      string showing enum value