org.neo4j.driver.NotificationClassification Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-java-driver Show documentation
Access to the Neo4j graph database through Java
The newest version!
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.neo4j.driver;

import org.neo4j.driver.util.Preview;

/**
 * Notification classification.
 *
 * @since 5.22.0
 */
@Preview(name = "GQL-status object")
public enum NotificationClassification implements NotificationCategory {
    /**
     * A hint category.
     * 
     * For instance, the given hint cannot be satisfied.
     */
    HINT,

    /**
     * An unrecognized category.
     * 

     * For instance, the query or command mentions entities that are unknown to the system.
     */
    UNRECOGNIZED,

    /**
     * An unsupported category.
     * 

     * For instance, the query/command is trying to use features that are not supported by the current system or using
     * features that are experimental and should not be used in production.
     */
    UNSUPPORTED,

    /**
     * A performance category.
     * 

     * For instance, the query uses costly operations and might be slow.
     */
    PERFORMANCE,

    /**
     * A deprecation category.
     * 

     * For instance, the query/command use deprecated features that should be replaced.
     */
    DEPRECATION,

    /**
     * A security category.
     * 

     * For instance, the security warnings.
     * 

     * Please note that this category was added to a later server version. Therefore, a compatible server version is
     * required to use it.
     */
    SECURITY,

    /**
     * A topology category.
     * 

     * For instance, the topology notifications.
     * 

     * Please note that this category was added to a later server version. Therefore, a compatible server version is
     * required to use it.
     */
    TOPOLOGY,

    /**
     * A generic category.
     * 

     * For instance, notifications that are not part of a more specific class.
     */
    GENERIC,
    /**
     * A schema category.
     * 

     * For instance, notifications about indexes and constraints.
     * 
     * Please note that this category was added to a later server version. Therefore, a compatible server version is
     * required to use it.
     * @since 5.24.0
     */
    SCHEMA
}