Module org.neo4j.driver

Package org.neo4j.driver.summary

Interface GqlNotification

All Superinterfaces:

GqlStatusObject

All Known Implementing Classes:

InternalGqlNotification

@Preview(name="GQL-status object")
public sealed interface GqlNotification
extends GqlStatusObject
permits InternalGqlNotification

A notification subtype of the GqlStatusObject.

Since:

5.28.8

See Also:

• GqlStatusObject

Method Summary

Modifier and Type	Method	Description
Optional<NotificationClassification>	classification()	Returns NotificationClassification derived from the diagnostic record.
Optional<InputPosition>	position()	Returns a position in the query where this notification points to.
Optional<String>	rawClassification()	Returns notification classification from the diagnostic record as a String value retrieved directly from the diagnostic record.
Optional<String>	rawSeverity()	Returns the raw severity level of the notification as a String value retrieved directly from the diagnostic record.
Optional<NotificationSeverity>	severity()	Returns the severity level of the notification derived from the diagnostic record.

Methods inherited from interface org.neo4j.driver.summary.GqlStatusObject

diagnosticRecord, gqlStatus, statusDescription

Method Details

position

Optional<InputPosition> position()

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

severity

Optional<NotificationSeverity> severity()

Returns the severity level of the notification derived from the diagnostic record.

Returns:

the severity level of the notification

See Also:

• GqlStatusObject.diagnosticRecord()

rawSeverity

Optional<String> rawSeverity()

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

See Also:

• GqlStatusObject.diagnosticRecord()

classification

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

See Also:

• GqlStatusObject.diagnosticRecord()

rawClassification

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

See Also:

• GqlStatusObject.diagnosticRecord()