Package org.odpi.openmetadata.adminservices.configuration.registration

Enum Class AccessServiceDescription

java.lang.Object
java.lang.Enum<AccessServiceDescription>
org.odpi.openmetadata.adminservices.configuration.registration.AccessServiceDescription
All Implemented Interfaces:
Serializable, Comparable<AccessServiceDescription>, Constable
public enum AccessServiceDescription extends Enum<AccessServiceDescription> implements Serializable
AccessServiceDescription provides a list of registered OMAS services.

  • Enum Constant Details

  • Method Details

    • values

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

    • getAccessServiceDefinition

      public static AccessServiceDescription getAccessServiceDefinition(int accessServiceCode)
      Return the enum that corresponds with the supplied code.
      Parameters:
      accessServiceCode - requested code
      Returns:
      enum

    • getAccessServiceCode

      public int getAccessServiceCode()
      Return the code for this enum instance
      Returns:
      int type code

    • getAccessServiceDevelopmentStatus

      public ComponentDevelopmentStatus getAccessServiceDevelopmentStatus()
      Return the development status of the service.
      Returns:
      enum describing the status

    • getAccessServiceName

      public String getAccessServiceName()
      Return the default name for this enum instance.
      Returns:
      String default name

    • getAccessServiceFullName

      public String getAccessServiceFullName()
      Return the formal name for this enum instance.
      Returns:
      String default name

    • getAccessServiceURLMarker

      public String getAccessServiceURLMarker()
      Return the string that appears in the REST API URL that identifies the owning service. Null means no REST APIs supported by this service.
      Returns:
      String default URL marker

    • getAccessServiceDescription

      public String getAccessServiceDescription()
      Return the default description for the type for this enum instance.
      Returns:
      String default description

    • getAccessServiceWiki

      public String getAccessServiceWiki()
      Return the URL for the wiki page describing this access service.
      Returns:
      String URL for the wiki page