Package net.ygbstudio.jbrave.core.model

Enum Class BraveErrorCode

java.lang.Object
java.lang.Enum<BraveErrorCode>
net.ygbstudio.jbrave.core.model.BraveErrorCode
All Implemented Interfaces:
Serializable, Comparable<BraveErrorCode>, Constable
public enum BraveErrorCode extends Enum<BraveErrorCode>
Enumeration of Brave API error codes.

This enum represents the different error codes that the Brave API can return.

Author:
Yoham Gabriel @ YGB Studio

  • Enum Constant Details

    • INTERNAL

      public static final BraveErrorCode INTERNAL
      An internal server error.

    • QUOTA_LIMITED

      public static final BraveErrorCode QUOTA_LIMITED
      The request quota for the current period has been exhausted.

    • RATE_LIMITED

      public static final BraveErrorCode RATE_LIMITED
      The request was rate-limited; the client should honor the X-RateLimit-Reset window.

    • SUBSCRIPTION_TOKEN_INVALID

      public static final BraveErrorCode SUBSCRIPTION_TOKEN_INVALID
      The provided subscription token is not valid.

    • SUBSCRIPTION_NOT_FOUND

      public static final BraveErrorCode SUBSCRIPTION_NOT_FOUND
      The subscription token does not match any active subscription.

    • RESOURCE_NOT_ALLOWED

      public static final BraveErrorCode RESOURCE_NOT_ALLOWED
      The requested resource is not allowed under the current subscription plan.

    • OPTION_NOT_IN_PLAN

      public static final BraveErrorCode OPTION_NOT_IN_PLAN
      The requested option is not included in the current subscription plan.

    • USAGE_LIMIT_EXCEEDED

      public static final BraveErrorCode USAGE_LIMIT_EXCEEDED
      The usage limit for the current subscription has been exceeded.

    • INVALID_URL

      public static final BraveErrorCode INVALID_URL
      The request contained an invalid URL parameter.

    • VALIDATION

      public static final BraveErrorCode VALIDATION
      The request failed request-body validation.

  • Method Details

    • values

      public static BraveErrorCode[] 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 BraveErrorCode 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

    • toString

      public String toString()
      Overrides:
      toString in class Enum<BraveErrorCode>