Enum Class UnityCatalogSurveyRequestParameter
java.lang.Object
java.lang.Enum<UnityCatalogSurveyRequestParameter>
org.odpi.openmetadata.adapters.connectors.unitycatalog.controls.UnityCatalogSurveyRequestParameter
- All Implemented Interfaces:
Serializable
,Comparable<UnityCatalogSurveyRequestParameter>
,Constable
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionProperty name to control how much profiling the survey action service does. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturn the data type for the request parameter.Return the description of the request parameter.Return an example of the request parameter to help users understand how to set it up.static List<RequestParameterType>
Retrieve the defined request parameters used by the Inside Catalog Survey Servicestatic List<RequestParameterType>
Retrieve the defined request parameters used by the Inside Schema Survey ServicegetName()
Return the name of the request parameter.Return a summary of this enum to use in a service provider.static List<RequestParameterType>
Retrieve all the defined request parametersstatic List<RequestParameterType>
Retrieve the defined request parameters used by the Server Survey ServicetoString()
Output of this enum class and main value.Returns the enum constant of this class with the specified name.static UnityCatalogSurveyRequestParameter[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FINAL_ANALYSIS_STEP
Property name to control how much profiling the survey action service does. -
CATALOG_NAME
-
SCHEMA_NAME
-
-
Field Details
-
name
-
description
-
dataType
-
example
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getName
Return the name of the request parameter.- Returns:
- string name
-
getDescription
Return the description of the request parameter.- Returns:
- text
-
getDataType
Return the data type for the request parameter.- Returns:
- data type name
-
getExample
Return an example of the request parameter to help users understand how to set it up.- Returns:
- example
-
getRequestParameterTypes
Retrieve all the defined request parameters- Returns:
- list of request parameter types
-
getServerSurveyRequestParameterTypes
Retrieve the defined request parameters used by the Server Survey Service- Returns:
- list of request parameter types
-
getInsideCatalogSurveyRequestParameterTypes
Retrieve the defined request parameters used by the Inside Catalog Survey Service- Returns:
- list of request parameter types
-
getInsideSchemaSurveyRequestParameterTypes
Retrieve the defined request parameters used by the Inside Schema Survey Service- Returns:
- list of request parameter types
-
getRequestParameterType
Return a summary of this enum to use in a service provider.- Returns:
- request parameter type
-
toString
Output of this enum class and main value.- Overrides:
toString
in classEnum<UnityCatalogSurveyRequestParameter>
- Returns:
- string showing enum value
-