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

Enum EngineServiceDescription

java.lang.Object

java.lang.Enum<EngineServiceDescription>

org.odpi.openmetadata.adminservices.configuration.registration.EngineServiceDescription

All Implemented Interfaces:

Serializable, Comparable<EngineServiceDescription>

public enum EngineServiceDescription
extends Enum<EngineServiceDescription>
implements Serializable

EngineServiceDescription provides a list of registered engine services.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSET_ANALYSIS_OMES
GOVERNANCE_ACTION_OMES
REPOSITORY_GOVERNANCE_OMES

Method Summary

Modifier and Type	Method	Description
int	getEngineServiceCode()	Return the code for this enum instance
static EngineServiceDescription	getEngineServiceDefinition(int engineServiceCode)	Return the enum that corresponds with the supplied code.
String	getEngineServiceDescription()	Return the default description for the type for this enum instance.
ComponentDevelopmentStatus	getEngineServiceDevelopmentStatus()	Return the development status of the service.
String	getEngineServiceFullName()	Return the formal name for this enum instance.
String	getEngineServiceName()	Return the default name for this enum instance.
String	getEngineServicePartnerService()	Return the full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.
String	getEngineServiceURLMarker()	Return the string that appears in the REST API URL that identifies the owning service.
String	getEngineServiceWiki()	Return the URL for the wiki page describing this engine service.
static EngineServiceDescription	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EngineServiceDescription[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASSET_ANALYSIS_OMES

public static final EngineServiceDescription ASSET_ANALYSIS_OMES

GOVERNANCE_ACTION_OMES

public static final EngineServiceDescription GOVERNANCE_ACTION_OMES

REPOSITORY_GOVERNANCE_OMES

public static final EngineServiceDescription REPOSITORY_GOVERNANCE_OMES

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(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:

IllegalArgumentException - if this enum type 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

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 full name of the Open Metadata Access Service (OMAS) that this engine service is partnered with.

Returns:

Full name of OMAS