Package org.odpi.openmetadata.contentpacks.core

Enum Class DataAssetTemplateDefinition

java.lang.Object

java.lang.Enum<DataAssetTemplateDefinition>

org.odpi.openmetadata.contentpacks.core.DataAssetTemplateDefinition

All Implemented Interfaces:

Serializable, Comparable<DataAssetTemplateDefinition>, Constable, TemplateDefinition

public enum DataAssetTemplateDefinition
extends Enum<DataAssetTemplateDefinition>
implements TemplateDefinition

A description of the templates for technology-specific data assets. The template consists of a DataSet asset, plus a connection, linked to the supplied connector type and an endpoint. Note: this is the template for both DataStores and DataSets - the DataSetContent relationship is not set up in the template - this is the job of the cataloguers to establish this lineage relationship.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARCHIVE_FILE_TEMPLATE
AUDIO_DATA_FILE_TEMPLATE
AVRO_FILE_TEMPLATE
BUILD_FILE_TEMPLATE
CSV_FILE_TEMPLATE
DATA_FILE_TEMPLATE
DATA_FOLDER_TEMPLATE
DB2LUW_DATABASE_TEMPLATE
DB2LUW_SCHEMA_TEMPLATE
DOCUMENT_TEMPLATE
DUCKDB_DATABASE_TEMPLATE
DUCKDB_SCHEMA_TEMPLATE
EXECUTABLE_FILE_TEMPLATE
FILE_FOLDER_TEMPLATE
JSON_FILE_TEMPLATE
KAFKA_TOPIC_TEMPLATE
KEYSTORE_FILE_TEMPLATE
MSSQL_DATABASE_TEMPLATE
MSSQL_SCHEMA_TEMPLATE
ORACLE_DATABASE_TEMPLATE
ORACLE_SCHEMA_TEMPLATE
PARQUET_FILE_TEMPLATE
POSTGRES_DATABASE_TEMPLATE
POSTGRES_SCHEMA_TEMPLATE
PROPERTIES_FILE_TEMPLATE
RASTER_DATA_FILE_TEMPLATE
SCRIPT_FILE_TEMPLATE
SOURCE_CODE_FILE_TEMPLATE
SPREADSHEET_FILE_TEMPLATE
THREE_D_IMAGE_DATA_FILE_TEMPLATE
VECTOR_DATA_FILE_TEMPLATE
VIDEO_DATA_FILE_TEMPLATE
XML_FILE_TEMPLATE
YAML_FILE_TEMPLATE

Method Summary

Modifier and Type	Method	Description
String	getAssetDescription()	Return the name for the associated capability.
String	getAssetName()	Return the name of the asset.
Map<String,Object>	getConfigurationProperties()	Return the configuration properties for the connection.
String	getConnectorTypeGUID()	Return the connector type GUID for the connection.
ContentPackDefinition	getContentPackDefinition()	Get identifier of content pack where this template should be located.
DeployedImplementationTypeDefinition	getDeployedImplementationType()	Return the supported deployed implementation for this template.
String	getElementVersionIdentifier()	Return the value to use in the element that describes its version.
String	getEncoding()	Return the type of encoding.
String	getEncodingLanguage()	Return the optional encoding language used by the asset.
Map<String,Object>	getExtendedProperties()	Return the properties defined for the asset subtype.
String	getNetworkAddress()	Return the endpoint address.
List<PlaceholderPropertyType>	getPlaceholders()	Return the list of placeholders supported by this template.
String	getQualifiedName()	Return the name of the server where this asset resides.
List<ReplacementAttributeType>	getReplacementAttributes()	Return the list of attributes that should be supplied by the caller using this template.
String	getSecretsCollectionName()	Return the name of the secrets collection to use to locate this asset's secrets.
String	getSecretsStoreConnectorTypeGUID()	Return the optional secrets store connector provider for the server.
String	getSecretsStoreFileName()	Return the location of the secrets store.
String	getSecretsStorePurpose()	Return the purpose of the secrets store.
String	getTemplateDescription()	Return the description to go in the template classification.
String	getTemplateGUID()	Return the unique identifier of the template.
String	getTemplateName()	Return the name to go in the template classification.
String	getTemplateVersionIdentifier()	Return the version identifier for the template classification.
String	toString()	JSON-style toString
static DataAssetTemplateDefinition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataAssetTemplateDefinition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

POSTGRES_DATABASE_TEMPLATE

public static final DataAssetTemplateDefinition POSTGRES_DATABASE_TEMPLATE

POSTGRES_SCHEMA_TEMPLATE

public static final DataAssetTemplateDefinition POSTGRES_SCHEMA_TEMPLATE

MSSQL_DATABASE_TEMPLATE

public static final DataAssetTemplateDefinition MSSQL_DATABASE_TEMPLATE

MSSQL_SCHEMA_TEMPLATE

public static final DataAssetTemplateDefinition MSSQL_SCHEMA_TEMPLATE

ORACLE_DATABASE_TEMPLATE

public static final DataAssetTemplateDefinition ORACLE_DATABASE_TEMPLATE

ORACLE_SCHEMA_TEMPLATE

public static final DataAssetTemplateDefinition ORACLE_SCHEMA_TEMPLATE

DB2LUW_DATABASE_TEMPLATE

public static final DataAssetTemplateDefinition DB2LUW_DATABASE_TEMPLATE

DB2LUW_SCHEMA_TEMPLATE

public static final DataAssetTemplateDefinition DB2LUW_SCHEMA_TEMPLATE

DUCKDB_DATABASE_TEMPLATE

public static final DataAssetTemplateDefinition DUCKDB_DATABASE_TEMPLATE

DUCKDB_SCHEMA_TEMPLATE

public static final DataAssetTemplateDefinition DUCKDB_SCHEMA_TEMPLATE

KAFKA_TOPIC_TEMPLATE

public static final DataAssetTemplateDefinition KAFKA_TOPIC_TEMPLATE

FILE_FOLDER_TEMPLATE

public static final DataAssetTemplateDefinition FILE_FOLDER_TEMPLATE

DATA_FOLDER_TEMPLATE

public static final DataAssetTemplateDefinition DATA_FOLDER_TEMPLATE

DATA_FILE_TEMPLATE

public static final DataAssetTemplateDefinition DATA_FILE_TEMPLATE

CSV_FILE_TEMPLATE

public static final DataAssetTemplateDefinition CSV_FILE_TEMPLATE

AVRO_FILE_TEMPLATE

public static final DataAssetTemplateDefinition AVRO_FILE_TEMPLATE

JSON_FILE_TEMPLATE

public static final DataAssetTemplateDefinition JSON_FILE_TEMPLATE

PARQUET_FILE_TEMPLATE

public static final DataAssetTemplateDefinition PARQUET_FILE_TEMPLATE

SPREADSHEET_FILE_TEMPLATE

public static final DataAssetTemplateDefinition SPREADSHEET_FILE_TEMPLATE

XML_FILE_TEMPLATE

public static final DataAssetTemplateDefinition XML_FILE_TEMPLATE

DOCUMENT_TEMPLATE

public static final DataAssetTemplateDefinition DOCUMENT_TEMPLATE

AUDIO_DATA_FILE_TEMPLATE

public static final DataAssetTemplateDefinition AUDIO_DATA_FILE_TEMPLATE

VIDEO_DATA_FILE_TEMPLATE

public static final DataAssetTemplateDefinition VIDEO_DATA_FILE_TEMPLATE

THREE_D_IMAGE_DATA_FILE_TEMPLATE

public static final DataAssetTemplateDefinition THREE_D_IMAGE_DATA_FILE_TEMPLATE

RASTER_DATA_FILE_TEMPLATE

public static final DataAssetTemplateDefinition RASTER_DATA_FILE_TEMPLATE

VECTOR_DATA_FILE_TEMPLATE

public static final DataAssetTemplateDefinition VECTOR_DATA_FILE_TEMPLATE

ARCHIVE_FILE_TEMPLATE

public static final DataAssetTemplateDefinition ARCHIVE_FILE_TEMPLATE

KEYSTORE_FILE_TEMPLATE

public static final DataAssetTemplateDefinition KEYSTORE_FILE_TEMPLATE

SOURCE_CODE_FILE_TEMPLATE

public static final DataAssetTemplateDefinition SOURCE_CODE_FILE_TEMPLATE

BUILD_FILE_TEMPLATE

public static final DataAssetTemplateDefinition BUILD_FILE_TEMPLATE

EXECUTABLE_FILE_TEMPLATE

public static final DataAssetTemplateDefinition EXECUTABLE_FILE_TEMPLATE

SCRIPT_FILE_TEMPLATE

public static final DataAssetTemplateDefinition SCRIPT_FILE_TEMPLATE

PROPERTIES_FILE_TEMPLATE

public static final DataAssetTemplateDefinition PROPERTIES_FILE_TEMPLATE

YAML_FILE_TEMPLATE

public static final DataAssetTemplateDefinition YAML_FILE_TEMPLATE

Method Details

values

public static DataAssetTemplateDefinition[] 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 DataAssetTemplateDefinition 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

getTemplateGUID

public String getTemplateGUID()

Return the unique identifier of the template.

Specified by:

getTemplateGUID in interface TemplateDefinition

Returns:

name

getTemplateName

public String getTemplateName()

Return the name to go in the template classification.

Specified by:

getTemplateName in interface TemplateDefinition

Returns:

string

getTemplateDescription

public String getTemplateDescription()

Return the description to go in the template classification.

Specified by:

getTemplateDescription in interface TemplateDefinition

Returns:

string

getTemplateVersionIdentifier

public String getTemplateVersionIdentifier()

Return the version identifier for the template classification.

Specified by:

getTemplateVersionIdentifier in interface TemplateDefinition

Returns:

string

getDeployedImplementationType

public DeployedImplementationTypeDefinition getDeployedImplementationType()

Return the supported deployed implementation for this template.

Specified by:

getDeployedImplementationType in interface TemplateDefinition

Returns:

enum

getElementVersionIdentifier

public String getElementVersionIdentifier()

Return the value to use in the element that describes its version.

Specified by:

getElementVersionIdentifier in interface TemplateDefinition

Returns:

version identifier placeholder

getAssetName

public String getAssetName()

Return the name of the asset.

Returns:

enum

getAssetDescription

public String getAssetDescription()

Return the name for the associated capability.

Returns:

string

getQualifiedName

public String getQualifiedName()

Return the name of the server where this asset resides.

Returns:

string

getExtendedProperties

public Map<String,Object> getExtendedProperties()

Return the properties defined for the asset subtype.

Returns:

map

getEncoding

public String getEncoding()

Return the type of encoding. If null no encoding classification is added to the asset.

Returns:

string

getEncodingLanguage

public String getEncodingLanguage()

Return the optional encoding language used by the asset.

Returns:

string

getConnectorTypeGUID

public String getConnectorTypeGUID()

Return the connector type GUID for the connection.

Returns:

string

getNetworkAddress

public String getNetworkAddress()

Return the endpoint address.

Returns:

string

getConfigurationProperties

public Map<String,Object> getConfigurationProperties()

Return the configuration properties for the connection.

Returns:

map

getSecretsCollectionName

public String getSecretsCollectionName()

Return the name of the secrets collection to use to locate this asset's secrets.

Returns:

name

getSecretsStorePurpose

public String getSecretsStorePurpose()

Return the purpose of the secrets store.

Returns:

name

getSecretsStoreConnectorTypeGUID

public String getSecretsStoreConnectorTypeGUID()

Return the optional secrets store connector provider for the server.

Returns:

connector provider

getSecretsStoreFileName

public String getSecretsStoreFileName()

Return the location of the secrets store.

Returns:

path name of file

getPlaceholders

public List<PlaceholderPropertyType> getPlaceholders()

Return the list of placeholders supported by this template.

Specified by:

getPlaceholders in interface TemplateDefinition

Returns:

list of placeholder types

getReplacementAttributes

public List<ReplacementAttributeType> getReplacementAttributes()

Return the list of attributes that should be supplied by the caller using this template.

Specified by:

getReplacementAttributes in interface TemplateDefinition

Returns:

list of replacement attributes

getContentPackDefinition

public ContentPackDefinition getContentPackDefinition()

Get identifier of content pack where this template should be located.

Returns:

content pack definition

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<DataAssetTemplateDefinition>

Returns:

return string containing the property names and values