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

Enum Class EngineServiceDescription

java.lang.Object
java.lang.Enum<EngineServiceDescription>
org.odpi.openmetadata.adminservices.configuration.registration.EngineServiceDescription
All Implemented Interfaces:
Serializable, Comparable<EngineServiceDescription>, Constable
public enum EngineServiceDescription extends Enum<EngineServiceDescription>
EngineServiceDescription provides a list of registered engine services. These engine services run on an Engine Host OMAG Server.

  • Enum Constant Details

    • ASSET_ANALYSIS_OMES

      public static final EngineServiceDescription ASSET_ANALYSIS_OMES
      Analyses the content of an asset's real world counterpart (resource), generates annotations in a discovery analysis report that is attached to the asset in the open metadata repositories.

    • GOVERNANCE_ACTION_OMES

      public static final EngineServiceDescription GOVERNANCE_ACTION_OMES
      Executes requested governance action services to monitor, assess and maintain metadata and its real-world counterparts.

    • REPOSITORY_GOVERNANCE_OMES

      public static final EngineServiceDescription REPOSITORY_GOVERNANCE_OMES
      Dynamically govern open metadata repositories in the connected cohorts.

    • CONTEXT_EVENT_OMES

      public static final EngineServiceDescription CONTEXT_EVENT_OMES
      Executes requested event action services to monitor, assess and maintain context events.

    • SURVEY_ACTION_OMES

      public static final EngineServiceDescription SURVEY_ACTION_OMES
      Analyses the content of an asset's real world counterpart (resource), generates annotations in a survey report that is attached to the asset in the open metadata repositories.

  • Method Details

    • values

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

    • getEngineServiceDefinition

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

    • getEngineServiceNames

      public static List<String> getEngineServiceNames()
      Return the full names of all the registered engine service names.
      Returns:
      list of names

    • 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 String getEngineServiceName()
      Return the default name for this enum instance.
      Returns:
      String default name

    • getEngineServiceFullName

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

    • getEngineServiceURLMarker

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

    • getEngineServiceDescription

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

    • getEngineServiceWiki

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

    • getEngineServicePartnerService

      public String getEngineServicePartnerService()
      Return the description of the service that this engine service is partnered with.
      Returns:
      Full name of related service

    • getHostedGovernanceEngineType

      public String getHostedGovernanceEngineType()
      Return the open metadata type of governance engine that this engine service supports.
      Returns:
      engine open metadata type name

    • getHostedGovernanceServiceType

      public String getHostedGovernanceServiceType()
      Return the open metadata type of governance service that this engine service supports.
      Returns:
      governance service connector open metadata type name

    • getHostedGovernanceEngineDeployedImplementationType

      public String getHostedGovernanceEngineDeployedImplementationType()
      Return the type of governance engine that this engine service supports.
      Returns:
      engine deployed implementation type name

    • getHostedGovernanceServiceDeployedImplementationType

      public String getHostedGovernanceServiceDeployedImplementationType()
      Return the deployed implementation type of governance service that this engine service supports.
      Returns:
      governance service connector deployed implementation type name