Enum Class UCErrorCode
- All Implemented Interfaces:
Serializable
,Comparable<UCErrorCode>
,Constable
,ExceptionMessageSet
The UCErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with
the Kafka monitor integration connector. It is used in conjunction with both Checked and Runtime (unchecked) exceptions.
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 consumer 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 ConstantsEnum ConstantDescriptionUNITY-CATALOG-CONNECTOR-503-001 - A client-side exception {0} was received from API call {1} to URL {2}.UNITY-CATALOG-CONNECTOR-400-002 - The {0} Unity Catalog Connector has not been supplied with a {1} property valueUNITY-CATALOG-CONNECTOR-400-001 - Connection {0} has been configured without the URL to the Unity Catalog (UC)UNITY-CATALOG-CONNECTOR-500-001 - The {0} Unity Catalog connector received an unexpected exception {1} during method {2}; the error message was: {3} -
Method Summary
Modifier and TypeMethodDescriptionRetrieve a message definition object for an exception.getMessageDefinition
(String... params) Retrieve a message definition object for an exception.toString()
JSON-style toStringstatic UCErrorCode
Returns the enum constant of this class with the specified name.static UCErrorCode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NULL_URL
UNITY-CATALOG-CONNECTOR-400-001 - Connection {0} has been configured without the URL to the Unity Catalog (UC) -
MISSING_PROPERTY_NAME
UNITY-CATALOG-CONNECTOR-400-002 - The {0} Unity Catalog Connector has not been supplied with a {1} property value -
UNEXPECTED_EXCEPTION
UNITY-CATALOG-CONNECTOR-500-001 - The {0} Unity Catalog connector received an unexpected exception {1} during method {2}; the error message was: {3} -
CLIENT_SIDE_REST_API_ERROR
UNITY-CATALOG-CONNECTOR-503-001 - A client-side exception {0} was received from API call {1} to URL {2}. The error message was {3}
-
-
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
-
getMessageDefinition
Retrieve a message definition object for an exception. This method is used when there are no message inserts.- Specified by:
getMessageDefinition
in interfaceExceptionMessageSet
- Returns:
- message definition object.
-
getMessageDefinition
Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.- Specified by:
getMessageDefinition
in interfaceExceptionMessageSet
- Parameters:
params
- array of parameters (all strings). They are inserted into the message according to the numbering in the message text.- Returns:
- message definition object.
-
toString
JSON-style toString- Overrides:
toString
in classEnum<UCErrorCode>
- Returns:
- string of property names and values for this enum
-