Enum EngineServiceDescription

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EngineServiceDescription>

    public enum EngineServiceDescription
    extends java.lang.Enum<EngineServiceDescription>
    implements java.io.Serializable
    EngineServiceDescription provides a list of registered engine services.
    • Method Detail

      • values

        public static EngineServiceDescription[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (EngineServiceDescription c : EngineServiceDescription.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static EngineServiceDescription valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getEngineServiceDefinition

        public static EngineServiceDescription getEngineServiceDefinition​(int engineServiceCode)
        Return the enum that corresponds with the supplied code.
        Parameters:
        engineServiceCode - requested code
        Returns:
        enum
      • getEngineServiceCode

        public int getEngineServiceCode()
        Return the code for this enum instance
        Returns:
        int type code
      • getEngineServiceDevelopmentStatus

        public ComponentDevelopmentStatus getEngineServiceDevelopmentStatus()
        Return the development status of the service.
        Returns:
        enum describing the status
      • getEngineServiceName

        public java.lang.String getEngineServiceName()
        Return the default name for this enum instance.
        Returns:
        String default name
      • getEngineServiceFullName

        public java.lang.String getEngineServiceFullName()
        Return the formal name for this enum instance.
        Returns:
        String default name
      • getEngineServiceURLMarker

        public java.lang.String getEngineServiceURLMarker()
        Return the string that appears in the REST API URL that identifies the owning service.
        Returns:
        String default URL marker
      • getEngineServiceDescription

        public java.lang.String getEngineServiceDescription()
        Return the default description for the type for this enum instance.
        Returns:
        String default description
      • getEngineServiceWiki

        public java.lang.String getEngineServiceWiki()
        Return the URL for the wiki page describing this engine service.
        Returns:
        String URL for the wiki page
      • getEngineServicePartnerService

        public java.lang.String getEngineServicePartnerService()
        Return the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.
        Returns:
        Full name of OMAS