Enum Class LineageWarehouseErrorCode
java.lang.Object
java.lang.Enum<LineageWarehouseErrorCode>
org.odpi.openmetadata.governanceservers.lineagewarehouse.ffdc.LineageWarehouseErrorCode
- All Implemented Interfaces:
Serializable
,Comparable<LineageWarehouseErrorCode>
,Constable
The ODF error code is used to define first failure data capture (FFDC) for errors that occur when working with
Open Lineage 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 Identifier - 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
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionLINEAGE-WAREHOUSE-400-002 - Lineage Warehouse client access service configuration field {0} does not have a valid value.LINEAGE-WAREHOUSE-400-001 - The {0} Lineage Warehouse does not have a configuration document -
Method Summary
Modifier and TypeMethodDescriptionReturns the unique identifier for the error message.getFormattedErrorMessage
(String... params) Returns the error message with the placeholders filled out with the supplied parameters.int
Returns a description of the action taken by the system when the condition that caused this exception was detected.Returns instructions of how to resolve the issue reported in this exception.static LineageWarehouseErrorCode
Returns the enum constant of this class with the specified name.static LineageWarehouseErrorCode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NO_CONFIG_DOC
LINEAGE-WAREHOUSE-400-001 - The {0} Lineage Warehouse does not have a configuration document -
BAD_ACCESS_SERVICE_CONFIG
LINEAGE-WAREHOUSE-400-002 - Lineage Warehouse client access service configuration field {0} does not have a valid value. -
ERROR_INITIALIZING_LINEAGE_GRAPH_CONNECTOR_DB
-
ERROR_STARTING_LINEAGE_GRAPH_CONNECTOR
-
ERROR_OBTAINING_IN_TOPIC_CONNECTOR
-
ERROR_OBTAINING_LINEAGE_GRAPH_CONNECTOR
-
ERROR_STARTING_IN_TOPIC_CONNECTOR
-
ERROR_DISCONNECTING_LINEAGE_GRAPH_CONNECTOR
-
ERROR_DISCONNECTING_IN_TOPIC_CONNECTOR
-
ERROR_ENTITY_NOT_FOUND
-
ERROR_LINEAGE_NOT_FOUND
-
ERROR_TYPES_NOT_FOUND
-
GRAPH_INITIALIZATION_ERROR
-
OPEN_LINEAGE_HANDLER_NOT_INSTANTIATED
-
LINEAGE_CYCLE
-
ERROR_INITIALIZING_OLS
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getHTTPErrorCode
public int getHTTPErrorCode() -
getErrorMessageId
Returns the unique identifier for the error message.- Returns:
- errorMessageId
-
getFormattedErrorMessage
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
Returns a description of the action taken by the system when the condition that caused this exception was detected.- Returns:
- systemAction
-
getUserAction
Returns instructions of how to resolve the issue reported in this exception.- Returns:
- userAction
-