Package org.odpi.openmetadata.frameworks.discovery.properties

Enum Class DiscoveryRequestStatus

java.lang.Object

java.lang.Enum<DiscoveryRequestStatus>

org.odpi.openmetadata.frameworks.discovery.properties.DiscoveryRequestStatus

All Implemented Interfaces:

Serializable, Comparable<DiscoveryRequestStatus>, Constable

public enum DiscoveryRequestStatus
extends Enum<DiscoveryRequestStatus>
implements Serializable

DiscoveryRequestStatus defines the current status for a discovery request made to a discovery engine.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVATING	Discovery service is being initialized in the discovery engine.
COMPLETED	Discovery service has completed successfully.
FAILED	Discovery service has failed.
IN_PROGRESS	Discovery service is executing.
OTHER	Discovery service has a status that is not covered by this enum.
UNKNOWN_STATUS	Discovery service status is unknown.
WAITING	Discovery service is waiting to execute in the discovery engine.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the status for this enum instance.
String	getName()	Return the default name for the status for this enum instance.
String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOpenTypeOrdinal()	Return the code for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal()	Return the status code for this enum instance
String	toString()	Standard toString method.
static DiscoveryRequestStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DiscoveryRequestStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

WAITING

public static final DiscoveryRequestStatus WAITING

Discovery service is waiting to execute in the discovery engine.

ACTIVATING

public static final DiscoveryRequestStatus ACTIVATING

Discovery service is being initialized in the discovery engine.

IN_PROGRESS

public static final DiscoveryRequestStatus IN_PROGRESS

Discovery service is executing.

FAILED

public static final DiscoveryRequestStatus FAILED

Discovery service has failed.

COMPLETED

public static final DiscoveryRequestStatus COMPLETED

Discovery service has completed successfully.

OTHER

public static final DiscoveryRequestStatus OTHER

Discovery service has a status that is not covered by this enum.

UNKNOWN_STATUS

public static final DiscoveryRequestStatus UNKNOWN_STATUS

Discovery service status is unknown.

Method Details

values

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

getOrdinal

public int getOrdinal()

Return the status code for this enum instance

Returns:

int status code

getName

public String getName()

Return the default name for the status for this enum instance.

Returns:

String default status name

getDescription

public String getDescription()

Return the default description for the status for this enum instance.

Returns:

String default status description

getOpenTypeOrdinal

public int getOpenTypeOrdinal()

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

Returns:

int code number

getOpenTypeGUID

public String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<DiscoveryRequestStatus>

Returns:

print out of variables in a JSON-style