- All Known Implementing Classes:
InternalNotification
Representation for notifications found when executing a query.
A notification can be visualized in a client pinpointing problems or other information about the query.
- Since:
- 1.0
-
Method Summary
Modifier and TypeMethodDescriptiondefault Optional<NotificationCategory>
category()
Returns the category of the notification.code()
Returns a notification code for the discovered issue.Returns a longer description of the notification.position()
The position in the query where this notification points to.Returns the raw category of the notification as a String returned by the server.Returns the raw severity level of the notification as a String returned by the server.default String
severity()
Deprecated.default Optional<NotificationSeverity>
Returns the severity level of the notification.title()
Returns a short summary of the notification.
-
Method Details
-
code
String code()Returns a notification code for the discovered issue.- Returns:
- the notification code
-
title
String title()Returns a short summary of the notification.- Returns:
- the title of the notification.
-
description
String description()Returns a longer description of the notification.- Returns:
- the description of the notification.
-
position
InputPosition position()The position in the query where this notification points to. Not all notifications have a unique position to point to and in that case the position would be set to null.- Returns:
- the position in the query where the issue was found, or null if no position is associated with this notification.
-
severity
Deprecated.superseded byseverityLevel()
andrawSeverityLevel()
The severity level of the notification.- Returns:
- the severity level of the notification
-
severityLevel
Returns the severity level of the notification.- Returns:
- the severity level of the notification
- Since:
- 5.7
-
rawSeverityLevel
Returns the raw severity level of the notification as a String returned by the server.- Returns:
- the severity level of the notification
- Since:
- 5.7
-
category
Returns the category of the notification.- Returns:
- the category of the notification
- Since:
- 5.7
-
rawCategory
Returns the raw category of the notification as a String returned by the server.- Returns:
- the category of the notification
- Since:
- 5.7
-
severityLevel()
andrawSeverityLevel()