DiscoveryServerErrorCode (Discovery Engine API 1.4 API)

java.lang.Object
- java.lang.Enum<DiscoveryServerErrorCode>
- - org.odpi.openmetadata.discoveryserver.ffdc.DiscoveryServerErrorCode

All Implemented Interfaces:

Serializable, Comparable<DiscoveryServerErrorCode>
```
public enum DiscoveryServerErrorCode
extends Enum<DiscoveryServerErrorCode>
```
The ODF error code is used to define first failure data capture (FFDC) for errors that occur when working with ODF Discovery Services. It is used in conjunction with all ODF Exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:
- HTTP Error Code for translating between REST and JAVA - Typically the numbers used are:
- - 500 - internal error
  - 400 - invalid parameters
  - 404 - not found
  - 409 - data conflict errors - eg item already defined
- Error Message Id - to uniquely identify the message
- Error Message Text - includes placeholder to allow additional values to be captured
- SystemAction - describes the result of the error
- UserAction - describes how a user should correct the error

Enum Constant Summary

Enum Constants
Enum Constant and Description
`NO_CONFIG_DOC`
`NO_DISCOVERY_ENGINES`
`NO_DISCOVERY_ENGINES_STARTED`
`NO_OMAS_SERVER_NAME`
`NO_OMAS_SERVER_URL`
`SERVICE_INSTANCE_FAILURE`
`UNKNOWN_DISCOVERY_ENGINE`
`UNKNOWN_DISCOVERY_ENGINE_NAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getErrorMessageId()` Returns the unique identifier for the error message.
`String`	`getFormattedErrorMessage(String... params)` Returns the error message with the placeholders filled out with the supplied parameters.
`int`	`getHTTPErrorCode()`
`String`	`getSystemAction()` Returns a description of the action taken by the system when the condition that caused this exception was detected.
`String`	`getUserAction()` Returns instructions of how to resolve the issue reported in this exception.
`static DiscoveryServerErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DiscoveryServerErrorCode[]`	`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
  - NO_CONFIG_DOC
```
public static final DiscoveryServerErrorCode NO_CONFIG_DOC
```
  - NO_OMAS_SERVER_URL
```
public static final DiscoveryServerErrorCode NO_OMAS_SERVER_URL
```
  - NO_OMAS_SERVER_NAME
```
public static final DiscoveryServerErrorCode NO_OMAS_SERVER_NAME
```
  - NO_DISCOVERY_ENGINES
```
public static final DiscoveryServerErrorCode NO_DISCOVERY_ENGINES
```
  - UNKNOWN_DISCOVERY_ENGINE
```
public static final DiscoveryServerErrorCode UNKNOWN_DISCOVERY_ENGINE
```
  - UNKNOWN_DISCOVERY_ENGINE_NAME
```
public static final DiscoveryServerErrorCode UNKNOWN_DISCOVERY_ENGINE_NAME
```
  - SERVICE_INSTANCE_FAILURE
```
public static final DiscoveryServerErrorCode SERVICE_INSTANCE_FAILURE
```
  - NO_DISCOVERY_ENGINES_STARTED
```
public static final DiscoveryServerErrorCode NO_DISCOVERY_ENGINES_STARTED
```
- Method Detail
  - values
```
public static DiscoveryServerErrorCode[] 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 (DiscoveryServerErrorCode c : DiscoveryServerErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DiscoveryServerErrorCode 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
  - getHTTPErrorCode
```
public int getHTTPErrorCode()
```
  - getErrorMessageId
```
public String getErrorMessageId()
```
    Returns the unique identifier for the error message.
    
    Returns:
    
    errorMessageId
  - getFormattedErrorMessage
```
public String getFormattedErrorMessage(String... params)
```
    Returns the error message with the placeholders filled out with the supplied parameters.
    
    Parameters:
    
    params - strings that plug into the placeholders in the errorMessage
    
    Returns:
    
    errorMessage (formatted with supplied parameters)
  - getSystemAction
```
public String getSystemAction()
```
    Returns a description of the action taken by the system when the condition that caused this exception was detected.
    
    Returns:
    
    systemAction
  - getUserAction
```
public String getUserAction()
```
    Returns instructions of how to resolve the issue reported in this exception.
    
    Returns:
    
    userAction

Enum DiscoveryServerErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NO_CONFIG_DOC

NO_OMAS_SERVER_URL

NO_OMAS_SERVER_NAME

NO_DISCOVERY_ENGINES

UNKNOWN_DISCOVERY_ENGINE

UNKNOWN_DISCOVERY_ENGINE_NAME

SERVICE_INSTANCE_FAILURE

NO_DISCOVERY_ENGINES_STARTED

Method Detail

values

valueOf

getHTTPErrorCode

getErrorMessageId

getFormattedErrorMessage

getSystemAction

getUserAction