Interface Notification

All Known Implementing Classes:
InternalNotification

@Deprecated @Immutable public interface Notification
Deprecated.
superseded by GqlNotification.
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 Type
    Method
    Description
    Deprecated.
    Returns the category of the notification.
    Deprecated.
    Returns a notification code for the discovered issue.
    Deprecated.
    Returns a longer description of the notification.
    Deprecated.
    The position in the query where this notification points to.
    default Optional<String>
    Deprecated.
    Returns the raw category of the notification as a String returned by the server.
    default Optional<String>
    Deprecated.
    Returns the raw severity level of the notification as a String returned by the server.
    Deprecated.
    Returns the severity level of the notification.
    Deprecated.
    Returns a short summary of the notification.
  • Method Details

    • code

      String code()
      Deprecated.
      Returns a notification code for the discovered issue.
      Returns:
      the notification code
    • title

      String title()
      Deprecated.
      Returns a short summary of the notification.
      Returns:
      the title of the notification.
    • description

      String description()
      Deprecated.
      Returns a longer description of the notification.
      Returns:
      the description of the notification.
    • position

      InputPosition position()
      Deprecated.
      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.
    • severityLevel

      default Optional<NotificationSeverity> severityLevel()
      Deprecated.
      Returns the severity level of the notification.
      Returns:
      the severity level of the notification
      Since:
      5.7
    • rawSeverityLevel

      default Optional<String> rawSeverityLevel()
      Deprecated.
      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

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

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