Enum Class QueryExplainLevel

java.lang.Object
java.lang.Enum<QueryExplainLevel>
com.veeva.vault.sdk.api.query.QueryExplainLevel
All Implemented Interfaces:
Serializable, Comparable<QueryExplainLevel>, Constable

public enum QueryExplainLevel extends Enum<QueryExplainLevel>
Valid values for the level of detail returned by a VQL explain request.
See Also:
  • Enum Constant Details

    • VERBOSE

      public static final QueryExplainLevel VERBOSE
      Returns the query plan with cost estimates and per-target runtime details including estimated row counts, applied filters, applied ordering, and paging phase cost factors. Result type: QueryExplainVerboseResult.
    • ANALYZE

      public static final QueryExplainLevel ANALYZE
      Returns the full query plan based on analyzing the actual query execution. Result type: QueryExplainAnalyzeResult.
  • Method Details

    • values

      public static QueryExplainLevel[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static QueryExplainLevel valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null