Package com.chargebee.v4.exceptions.codes

Enum Class ForbiddenApiErrorCode

java.lang.Object

java.lang.Enum<ForbiddenApiErrorCode>

com.chargebee.v4.exceptions.codes.ForbiddenApiErrorCode

All Implemented Interfaces:

ApiErrorCode, Serializable, Comparable<ForbiddenApiErrorCode>, Constable

public enum ForbiddenApiErrorCode
extends Enum<ForbiddenApiErrorCode>
implements ApiErrorCode

API error codes for HTTP 403 responses

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
_UNKNOWN	Represents an unknown or unrecognized error code.
API_AUTHORIZATION_FAILED	API error code: api_authorization_failed
REQUEST_BLOCKED	API error code: request_blocked

Method Summary

Modifier and Type	Method	Description
static ForbiddenApiErrorCode	fromString(String value)	Convert an API string value to the corresponding enum constant.
String	getValue()	Get the string value of this error code as returned by the API.
boolean	isKnown()	Check if this error code is a known (non-unknown) value.
static ForbiddenApiErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ForbiddenApiErrorCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.chargebee.v4.exceptions.codes.ApiErrorCode

name

Enum Constant Details

REQUEST_BLOCKED

public static final ForbiddenApiErrorCode REQUEST_BLOCKED

API error code: request_blocked

API_AUTHORIZATION_FAILED

public static final ForbiddenApiErrorCode API_AUTHORIZATION_FAILED

API error code: api_authorization_failed

_UNKNOWN

public static final ForbiddenApiErrorCode _UNKNOWN

Represents an unknown or unrecognized error code. This allows forward compatibility when new error codes are added.

Method Details

values

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

getValue

public String getValue()

Get the string value of this error code as returned by the API.

Specified by:

getValue in interface ApiErrorCode

Returns:

the API string value, or null for _UNKNOWN

fromString

public static ForbiddenApiErrorCode fromString(String value)

Convert an API string value to the corresponding enum constant. Returns _UNKNOWN for unrecognized values to ensure forward compatibility.

Parameters:

value - the API string value

Returns:

the corresponding enum constant, or _UNKNOWN if not recognized

isKnown

public boolean isKnown()

Check if this error code is a known (non-unknown) value.

Specified by:

isKnown in interface ApiErrorCode

Returns:

true if this is a recognized error code