Package org.apache.druid.error

Enum DruidException.Persona

java.lang.Object
java.lang.Enum<DruidException.Persona>
org.apache.druid.error.DruidException.Persona
All Implemented Interfaces:
Serializable, Comparable<DruidException.Persona>
Enclosing class:
DruidException
public static enum DruidException.Persona extends Enum<DruidException.Persona>
The persona that the message on a DruidException is targeting

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ADMIN
    Represents an administrative user, a persona who is interacting with admin APIs and understands Druid query concepts without necessarily owning the infrastructure and operations of the cluster
    DEVELOPER
    Represents someone who has all of the context and knowledge to be actively diving into the Druid codebase.
    OPERATOR
    Represents a persona who actively owns and operates the cluster.
    USER
    Represents the end-user, a persona who is issuing queries to the Druid Query APIs

  • Method Summary

    Modifier and Type
    Method
    Description
    static DruidException.Persona
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DruidException.Persona[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • USER

      public static final DruidException.Persona USER
      Represents the end-user, a persona who is issuing queries to the Druid Query APIs

    • ADMIN

      public static final DruidException.Persona ADMIN
      Represents an administrative user, a persona who is interacting with admin APIs and understands Druid query concepts without necessarily owning the infrastructure and operations of the cluster

    • OPERATOR

      public static final DruidException.Persona OPERATOR
      Represents a persona who actively owns and operates the cluster. This persona is not assumed to understand Druid query concepts, but instead understand cluster operational concepts.

    • DEVELOPER

      public static final DruidException.Persona DEVELOPER
      Represents someone who has all of the context and knowledge to be actively diving into the Druid codebase. This persona exists as a catch-all for anything that is so deep and technically in the weeds that it is not possible to make a message that will make sense to a different persona. Generally speaking, there is a hope that only DEFENSIVE error messages will target this persona.

  • Method Details

    • values

      public static DruidException.Persona[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static DruidException.Persona valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null