Enum Class EndpointTemplateDefinition

java.lang.Object
java.lang.Enum<EndpointTemplateDefinition>
org.odpi.openmetadata.archiveutilities.openconnectors.EndpointTemplateDefinition
All Implemented Interfaces:
Serializable, Comparable<EndpointTemplateDefinition>, Constable, TemplateDefinition

public enum EndpointTemplateDefinition extends Enum<EndpointTemplateDefinition> implements TemplateDefinition
A description of the default endpoint templates.
  • Enum Constant Details

  • Method Details

    • values

      public static EndpointTemplateDefinition[] 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 EndpointTemplateDefinition 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
    • getServerName

      public String getServerName()
      Return the name of the server.
      Returns:
      string
    • getEndpointDescription

      public String getEndpointDescription()
      Return the server description.
      Returns:
      string
    • getNetworkAddress

      public String getNetworkAddress()
      Return the endpoint address.
      Returns:
      string
    • getProtocol

      public String getProtocol()
      Return the endpoint protocol.
      Returns:
      string
    • 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
    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<EndpointTemplateDefinition>
      Returns:
      return string containing the property names and values