org.neo4j.driver.summary

Interface Notification

@Immutable
public interface Notification

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 and Description
String	code() Returns a notification code for the discovered issue.
String	description() Returns a longer description of the notification.
InputPosition	position() The position in the query where this notification points to.
String	severity() The severity level of the notification.
String	title() Returns a short summary of the notification.

Method Detail

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

String severity()

The severity level of the notification.

Returns:

the severity level of the notification