com.google.api.control.model

Enum CheckErrorInfo

java.lang.Object

java.lang.Enum<CheckErrorInfo>

com.google.api.control.model.CheckErrorInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CheckErrorInfo>

public enum CheckErrorInfo
extends java.lang.Enum<CheckErrorInfo>

CheckErrorInfo translates the CheckError received in a CheckResponse to HTTP codes and messages.

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_KEY_EXPIRED
API_KEY_INVALID
API_KEY_NOT_FOUND
API_KEY_NOT_PROVIDED
BILLING_DISABLED
BILLING_STATUS_UNAVAILABLE
CLIENT_APP_BLOCKED
IP_ADDRESS_BLOCKED
NAMESPACE_LOOKUP_UNAVAILABLE
NOT_FOUND
OK
PERMISSION_DENIED
PROJECT_DELETED
PROJECT_INVALID
REFERER_BLOCKED
SERVICE_NOT_ACTIVATED
SERVICE_STATUS_UNAVAILABLE
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static CheckErrorInfo	convert(com.google.api.servicecontrol.v1.CheckResponse response) Determines the CheckErrorInfo corresponding to response.
java.lang.String	fullMessage(java.lang.String projectId, java.lang.String detail) Expands message with the project Id and detail where necessary
int	getHttpCode()
java.lang.String	getMessage()
boolean	isApiKeyError()
static CheckErrorInfo	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CheckErrorInfo[]	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 Detail

OK

public static final CheckErrorInfo OK

NAMESPACE_LOOKUP_UNAVAILABLE

public static final CheckErrorInfo NAMESPACE_LOOKUP_UNAVAILABLE

SERVICE_STATUS_UNAVAILABLE

public static final CheckErrorInfo SERVICE_STATUS_UNAVAILABLE

BILLING_STATUS_UNAVAILABLE

public static final CheckErrorInfo BILLING_STATUS_UNAVAILABLE

NOT_FOUND

public static final CheckErrorInfo NOT_FOUND

API_KEY_NOT_FOUND

public static final CheckErrorInfo API_KEY_NOT_FOUND

API_KEY_EXPIRED

public static final CheckErrorInfo API_KEY_EXPIRED

API_KEY_INVALID

public static final CheckErrorInfo API_KEY_INVALID

SERVICE_NOT_ACTIVATED

public static final CheckErrorInfo SERVICE_NOT_ACTIVATED

PERMISSION_DENIED

public static final CheckErrorInfo PERMISSION_DENIED

IP_ADDRESS_BLOCKED

public static final CheckErrorInfo IP_ADDRESS_BLOCKED

REFERER_BLOCKED

public static final CheckErrorInfo REFERER_BLOCKED

CLIENT_APP_BLOCKED

public static final CheckErrorInfo CLIENT_APP_BLOCKED

PROJECT_DELETED

public static final CheckErrorInfo PROJECT_DELETED

PROJECT_INVALID

public static final CheckErrorInfo PROJECT_INVALID

BILLING_DISABLED

public static final CheckErrorInfo BILLING_DISABLED

UNKNOWN

public static final CheckErrorInfo UNKNOWN

API_KEY_NOT_PROVIDED

public static final CheckErrorInfo API_KEY_NOT_PROVIDED

Method Detail

values

public static CheckErrorInfo[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CheckErrorInfo c : CheckErrorInfo.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CheckErrorInfo valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fullMessage

public java.lang.String fullMessage(@Nullable
                                    java.lang.String projectId,
                                    @Nullable
                                    java.lang.String detail)

Expands message with the project Id and detail where necessary

Parameters:

projectId - the cloud project Id

detail - the error detail

Returns:

a string containing the expanded message

getMessage

public java.lang.String getMessage()

Returns:

the unexpanded error message

getHttpCode

public int getHttpCode()

Returns:

the equivalent http status code

isApiKeyError

public boolean isApiKeyError()

Returns:

true if original code corresponds to a API key issue, otherwise false

convert

public static final CheckErrorInfo convert(@Nullable
                                           com.google.api.servicecontrol.v1.CheckResponse response)

Determines the CheckErrorInfo corresponding to response.

Parameters:

response - a response from a CheckRequest

Returns:

CheckErrorInfo