Enum Class UnityCatalogPlaceholderProperty
java.lang.Object
java.lang.Enum<UnityCatalogPlaceholderProperty>
org.odpi.openmetadata.adapters.connectors.unitycatalog.controls.UnityCatalogPlaceholderProperty
- All Implemented Interfaces:
Serializable
,Comparable<UnityCatalogPlaceholderProperty>
,Constable
PlaceholderProperty provides some standard definitions for placeholder properties used to pass properties
to services that use templates.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe name of the catalog being described.The format of the data source: DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT.The name of a function within a schema and catalog in Unity Catalog (UC).The name of a schema within a catalog in Unity Catalog (UC).The location where the data associated with this element in Unity Catalog is stored.The name of a table within a schema and catalog in Unity Catalog (UC).The type a table: MANAGED or EXTERNAL.The name of a volume within a schema and catalog in Unity Catalog (UC).The type of volume: MANAGED or EXTERNAL. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic List<PlaceholderPropertyType>
Retrieve all the defined placeholder propertiesReturn the data type for the placeholder property.Return the description of the placeholder property.Return an example of the placeholder property to help users understand how to set it up.static List<PlaceholderPropertyType>
Retrieve all the defined placeholder propertiesgetName()
Return the name of the placeholder property.Return the placeholder to use when building templates.Return a summary of this enum to use in a service provider.static List<PlaceholderPropertyType>
Retrieve all the defined placeholder propertiesstatic List<PlaceholderPropertyType>
Retrieve all the defined placeholder propertiesstatic List<PlaceholderPropertyType>
Retrieve all the defined placeholder propertiesstatic List<PlaceholderPropertyType>
Retrieve all the defined placeholder propertiestoString()
Output of this enum class and main value.Returns the enum constant of this class with the specified name.static UnityCatalogPlaceholderProperty[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CATALOG_NAME
The name of the catalog being described. -
SCHEMA_NAME
The name of a schema within a catalog in Unity Catalog (UC). -
STORAGE_LOCATION
The location where the data associated with this element in Unity Catalog is stored. -
TABLE_NAME
The name of a table within a schema and catalog in Unity Catalog (UC). -
TABLE_TYPE
The type a table: MANAGED or EXTERNAL. -
DATA_SOURCE_FORMAT
The format of the data source: DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. -
VOLUME_NAME
The name of a volume within a schema and catalog in Unity Catalog (UC). -
VOLUME_TYPE
The type of volume: MANAGED or EXTERNAL. -
FUNCTION_NAME
The name of a function within a schema and catalog in Unity Catalog (UC).
-
-
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 placeholder property.- Returns:
- string name
-
getPlaceholder
Return the placeholder to use when building templates.- Returns:
- placeholder property
-
getDescription
Return the description of the placeholder property.- Returns:
- text
-
getDataType
Return the data type for the placeholder property.- Returns:
- data type name
-
getExample
Return an example of the placeholder property to help users understand how to set it up.- Returns:
- example
-
getServerPlaceholderPropertyTypes
Retrieve all the defined placeholder properties- Returns:
- list of placeholder property types
-
getCatalogPlaceholderPropertyTypes
Retrieve all the defined placeholder properties- Returns:
- list of placeholder property types
-
getSchemaPlaceholderPropertyTypes
Retrieve all the defined placeholder properties- Returns:
- list of placeholder property types
-
getTablePlaceholderPropertyTypes
Retrieve all the defined placeholder properties- Returns:
- list of placeholder property types
-
getVolumePlaceholderPropertyTypes
Retrieve all the defined placeholder properties- Returns:
- list of placeholder property types
-
getFunctionPlaceholderPropertyTypes
Retrieve all the defined placeholder properties- Returns:
- list of placeholder property types
-
getPlaceholderType
Return a summary of this enum to use in a service provider.- Returns:
- placeholder property type
-
toString
Output of this enum class and main value.- Overrides:
toString
in classEnum<UnityCatalogPlaceholderProperty>
- Returns:
- string showing enum value
-