org.odpi.openmetadata.accessservices.discoveryengine.events

Enum DiscoveryEngineEventType

java.lang.Object

java.lang.Enum<DiscoveryEngineEventType>

org.odpi.openmetadata.accessservices.discoveryengine.events.DiscoveryEngineEventType

All Implemented Interfaces:

Serializable, Comparable<DiscoveryEngineEventType>

public enum DiscoveryEngineEventType
extends Enum<DiscoveryEngineEventType>
implements Serializable

DiscoveryEngineEventType describes the different types of events produced by the Discovery Engine OMAS. Events are used to configure the Discovery Server (client of the Discovery Engine OMAS).

Enum Constant Summary

Enum Constants

Enum Constant and Description
REFRESH_DISCOVERY_ENGINE_EVENT
REFRESH_DISCOVERY_SERVICE_EVENT
UNKNOWN_DISCOVERY_ENGINE_EVENT

Method Summary

Modifier and Type	Method and Description
int	getEventTypeCode() Return the int identifier used for indexing based on the enum.
String	getEventTypeDescription() Return the default description for the enum value - used when natural resource bundle is not available.
String	getEventTypeName() Return the string name used for messages that include the enum.
String	toString() JSON-style toString
static DiscoveryEngineEventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DiscoveryEngineEventType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN_DISCOVERY_ENGINE_EVENT

public static final DiscoveryEngineEventType UNKNOWN_DISCOVERY_ENGINE_EVENT

REFRESH_DISCOVERY_ENGINE_EVENT

public static final DiscoveryEngineEventType REFRESH_DISCOVERY_ENGINE_EVENT

REFRESH_DISCOVERY_SERVICE_EVENT

public static final DiscoveryEngineEventType REFRESH_DISCOVERY_SERVICE_EVENT

Method Detail

values

public static DiscoveryEngineEventType[] 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 (DiscoveryEngineEventType c : DiscoveryEngineEventType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DiscoveryEngineEventType 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

getEventTypeCode

public int getEventTypeCode()

Return the int identifier used for indexing based on the enum.

Returns:

int identifier code

getEventTypeName

public String getEventTypeName()

Return the string name used for messages that include the enum.

Returns:

String name

getEventTypeDescription

public String getEventTypeDescription()

Return the default description for the enum value - used when natural resource bundle is not available.

Returns:

String default description

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<DiscoveryEngineEventType>

Returns:

return string containing the property names and values