Module org.neo4j.driver
Package org.neo4j.driver.summary

Interface Notification

All Superinterfaces:
GqlStatusObject
All Known Implementing Classes:
InternalNotification
@Immutable public interface Notification extends GqlStatusObject
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 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.
      See Also:

    • 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.

    • inputPosition

      @Preview(name="GQL-status object") default Optional<InputPosition> inputPosition()
      Returns a position in the query where this notification points to.

      Not all notifications have a unique position to point to and in that case an empty Optional is returned.

      Returns:
      an Optional of the InputPosition if available or an empty Optional otherwise
      Since:
      5.22.0

    • severity

      @Deprecated default String severity()
      Deprecated.
      superseded by severityLevel() and rawSeverityLevel()
      The severity level of the notification.
      Returns:
      the severity level of the notification

    • severityLevel

      default Optional<NotificationSeverity> severityLevel()
      Returns the severity level of the notification derived from the diagnostic record.
      Returns:
      the severity level of the notification
      Since:
      5.7
      See Also:

    • rawSeverityLevel

      default Optional<String> rawSeverityLevel()
      Returns the raw severity level of the notification as a String value retrieved directly from the diagnostic record.
      Returns:
      the severity level of the notification
      Since:
      5.7
      See Also:

    • classification

      @Preview(name="GQL-status object") default Optional<NotificationClassification> classification()
      Returns NotificationClassification derived from the diagnostic record.
      Returns:
      an Optional of NotificationClassification or an empty Optional when the classification is either absent or unrecognised
      Since:
      5.22.0
      See Also:

    • rawClassification

      @Preview(name="GQL-status object") default Optional<String> rawClassification()
      Returns notification classification from the diagnostic record as a String value retrieved directly from the diagnostic record.
      Returns:
      an Optional of notification classification or an empty Optional when it is absent
      Since:
      5.22.0
      See Also:

    • category

      default Optional<NotificationCategory> category()
      Returns the category of the notification.
      Returns:
      the category of the notification
      Since:
      5.7

    • rawCategory

      default Optional<String> rawCategory()
      Returns the raw category of the notification as a String returned by the server.
      Returns:
      the category of the notification
      Since:
      5.7