Package org.odpi.openmetadata.archiveutilities.openconnectors

Enum Class DataAssetTemplateDefinition

java.lang.Object
java.lang.Enum<DataAssetTemplateDefinition>
org.odpi.openmetadata.archiveutilities.openconnectors.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 SoftwareServer asset linked to a software capability, plus a connection, linked to the supplied connector type and an endpoint,

  • Enum Constant Details

  • 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