ApiErrorExtractor (util 2.1.2 API)

java.lang.Object
- com.google.cloud.hadoop.util.ApiErrorExtractor

```
public class ApiErrorExtractor
extends Object
```
Translates exceptions from API calls into higher-level meaning, while allowing injectability for testing how API errors are handled.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_NOT_CONFIGURED_REASON`
`static String`	`ACCOUNT_DISABLED_REASON`
`static String`	`FIELD_SIZE_TOO_LARGE_REASON`
`static String`	`GLOBAL_DOMAIN`
`static ApiErrorExtractor`	`INSTANCE` Singleton instance of the ApiErrorExtractor.
`static String`	`RATE_LIMITED_REASON`
`static String`	`RESOURCE_NOT_READY_REASON`
`static int`	`STATUS_CODE_RANGE_NOT_SATISFIABLE`
`static String`	`USAGE_LIMITS_DOMAIN`
`static String`	`USER_PROJECT_MISSING_MESSAGE`
`static String`	`USER_RATE_LIMITED_REASON`

Constructor Summary

Constructors
Constructor and Description

ApiErrorExtractor()
Deprecated.
use INSTANCE instead

Constructors
Constructor and Description
`ApiErrorExtractor()` Deprecated. use `INSTANCE` instead

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`accessDenied(IOException e)` Determines if the given exception indicates 'access denied'.
`boolean`	`accessDeniedNonRecoverable(IOException e)` Determines if the exception is a non-recoverable access denied code (such as account closed or marked for deletion).
`boolean`	`badRequest(IOException e)` Determines if the given exception indicates bad request.
`boolean`	`clientError(IOException e)` Determines if the exception is a client error.
`boolean`	`fieldSizeTooLarge(IOException e)` Determines if the given exception indicates 'field size too large'.
`String`	`getDebugInfo(IOException e)`
`protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo`	`getErrorInfo(IOException e)` Get the first ErrorInfo from an IOException if it is an instance of GoogleJsonResponseException, otherwise return null.
`String`	`getErrorMessage(IOException e)` Extracts the error message.
`protected int`	`getHttpStatusCode(com.google.api.client.googleapis.json.GoogleJsonResponseException e)` Returns HTTP status code from the given exception.
`protected com.google.api.client.googleapis.json.GoogleJsonError`	`getJsonError(IOException e)` If the exception is a GoogleJsonResponseException, get the error details, else return null.
`static com.google.api.client.googleapis.json.GoogleJsonResponseException`	`getJsonResponseException(Throwable throwable)`
`boolean`	`internalServerError(IOException e)` Determines if the exception is an internal server error.
`boolean`	`ioError(Throwable throwable)` Determines if a given Throwable is caused by an IO error.
`boolean`	`isClientError(IOException e)` Deprecated. use `clientError(IOException)` instead
`boolean`	`itemAlreadyExists(IOException e)` Determines if the given exception indicates 'item already exists'.
`boolean`	`itemNotFound(com.google.api.client.googleapis.json.GoogleJsonError e)` Deprecated. use `itemNotFound(IOException)` or `e.getCode() == HttpStatusCodes.STATUS_CODE_NOT_FOUND` instead
`boolean`	`itemNotFound(IOException e)` Determines if the given exception indicates 'item not found'.
`boolean`	`preconditionNotMet(IOException e)` Determines if the given IOException indicates 'precondition not met' Recursively checks getCause() if outer exception isn't an instance of the correct class.
`boolean`	`rangeNotSatisfiable(IOException e)` Determines if the given exception indicates 'range not satisfiable'.
`boolean`	`rateLimited(IOException e)` Determines if a given Throwable is caused by a rate limit being applied.
`boolean`	`readTimedOut(IOException e)` True if the exception is a "read timed out".
`protected boolean`	`recursiveCheckForCode(IOException e, int code)` Recursively checks getCause() if outer exception isn't an instance of the correct class.
`boolean`	`requestFailure(IOException e)` Determines if the given exception indicates intermittent request failure or failure caused by user error.
`boolean`	`resourceNotReady(IOException e)` Determines if the given exception indicates 'resource not ready'.
`boolean`	`socketError(Throwable throwable)` Determines if a given Throwable is caused by a socket error.
`IOException`	`toUserPresentableException(IOException e, String action)` Converts the exception to a user-presentable error message.
`String`	`toUserPresentableMessage(IOException e)` See `toUserPresentableMessage(IOException, String)`.
`String`	`toUserPresentableMessage(IOException e, String action)` Converts the exception to a user-presentable error message.
`boolean`	`unauthorized(IOException e)` Determines if the given exception indicates the request was unauthenticated.
`boolean`	`userProjectMissing(IOException e)` Determines if the given exception indicates that 'userProject' is missing in request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INSTANCE
```
public static final ApiErrorExtractor INSTANCE
```
    Singleton instance of the ApiErrorExtractor.
  - STATUS_CODE_RANGE_NOT_SATISFIABLE
```
public static final int STATUS_CODE_RANGE_NOT_SATISFIABLE
```
    See Also:
    
    Constant Field Values
  - GLOBAL_DOMAIN
```
public static final String GLOBAL_DOMAIN
```
    See Also:
    
    Constant Field Values
  - USAGE_LIMITS_DOMAIN
```
public static final String USAGE_LIMITS_DOMAIN
```
    See Also:
    
    Constant Field Values
  - RATE_LIMITED_REASON
```
public static final String RATE_LIMITED_REASON
```
    See Also:
    
    Constant Field Values
  - USER_RATE_LIMITED_REASON
```
public static final String USER_RATE_LIMITED_REASON
```
    See Also:
    
    Constant Field Values
  - ACCOUNT_DISABLED_REASON
```
public static final String ACCOUNT_DISABLED_REASON
```
    See Also:
    
    Constant Field Values
  - ACCESS_NOT_CONFIGURED_REASON
```
public static final String ACCESS_NOT_CONFIGURED_REASON
```
    See Also:
    
    Constant Field Values
  - RESOURCE_NOT_READY_REASON
```
public static final String RESOURCE_NOT_READY_REASON
```
    See Also:
    
    Constant Field Values
  - FIELD_SIZE_TOO_LARGE_REASON
```
public static final String FIELD_SIZE_TOO_LARGE_REASON
```
    See Also:
    
    Constant Field Values
  - USER_PROJECT_MISSING_MESSAGE
```
public static final String USER_PROJECT_MISSING_MESSAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ApiErrorExtractor
```
@Deprecated
public ApiErrorExtractor()
```
    Deprecated. use INSTANCE instead
- Method Detail
  - requestFailure
```
public boolean requestFailure(IOException e)
```
    Determines if the given exception indicates intermittent request failure or failure caused by user error.
  - accessDenied
```
public boolean accessDenied(IOException e)
```
    Determines if the given exception indicates 'access denied'. Recursively checks getCause() if outer exception isn't an instance of the correct class.
    Warning: this method only checks for access denied status code, however this may include potentially recoverable reason codes such as rate limiting. For alternative, see accessDeniedNonRecoverable(IOException).
  - badRequest
```
public boolean badRequest(IOException e)
```
    Determines if the given exception indicates bad request.
  - unauthorized
```
public boolean unauthorized(IOException e)
```
    Determines if the given exception indicates the request was unauthenticated. This can be caused by attaching invalid credentials to a request.
  - accessDeniedNonRecoverable
```
public boolean accessDeniedNonRecoverable(IOException e)
```
    Determines if the exception is a non-recoverable access denied code (such as account closed or marked for deletion).
  - isClientError
```
@Deprecated
public boolean isClientError(IOException e)
```
    Deprecated. use clientError(IOException) instead
  - clientError
```
public boolean clientError(IOException e)
```
    Determines if the exception is a client error.
  - internalServerError
```
public boolean internalServerError(IOException e)
```
    Determines if the exception is an internal server error.
  - itemAlreadyExists
```
public boolean itemAlreadyExists(IOException e)
```
    Determines if the given exception indicates 'item already exists'. Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - itemNotFound
```
@Deprecated
public boolean itemNotFound(com.google.api.client.googleapis.json.GoogleJsonError e)
```
    Deprecated. use itemNotFound(IOException) or e.getCode() == HttpStatusCodes.STATUS_CODE_NOT_FOUND instead
  - itemNotFound
```
public boolean itemNotFound(IOException e)
```
    Determines if the given exception indicates 'item not found'. Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - fieldSizeTooLarge
```
public boolean fieldSizeTooLarge(IOException e)
```
    Determines if the given exception indicates 'field size too large'. Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - resourceNotReady
```
public boolean resourceNotReady(IOException e)
```
    Determines if the given exception indicates 'resource not ready'. Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - preconditionNotMet
```
public boolean preconditionNotMet(IOException e)
```
    Determines if the given IOException indicates 'precondition not met' Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - rangeNotSatisfiable
```
public boolean rangeNotSatisfiable(IOException e)
```
    Determines if the given exception indicates 'range not satisfiable'. Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - rateLimited
```
public boolean rateLimited(IOException e)
```
    Determines if a given Throwable is caused by a rate limit being applied. Recursively checks getCause() if outer exception isn't an instance of the correct class.
    
    Parameters:
    
    e - The Throwable to check.
    
    Returns:
    
    True if the Throwable is a result of rate limiting being applied.
  - userProjectMissing
```
public boolean userProjectMissing(IOException e)
```
    Determines if the given exception indicates that 'userProject' is missing in request. Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - ioError
```
public boolean ioError(Throwable throwable)
```
    Determines if a given Throwable is caused by an IO error. Recursively checks getCause() if outer exception isn't an instance of the correct class.
    
    Parameters:
    
    throwable - The Throwable to check.
    
    Returns:
    
    True if the Throwable is a result of an IO error.
  - socketError
```
public boolean socketError(Throwable throwable)
```
    Determines if a given Throwable is caused by a socket error. Recursively checks getCause() if outer exception isn't an instance of the correct class.
    
    Parameters:
    
    throwable - The Throwable to check.
    
    Returns:
    
    True if the Throwable is a result of a socket error.
  - readTimedOut
```
public boolean readTimedOut(IOException e)
```
    True if the exception is a "read timed out".
  - getErrorMessage
```
public String getErrorMessage(IOException e)
```
    Extracts the error message.
  - toUserPresentableException
```
public IOException toUserPresentableException(IOException e,
                                              String action)
                                       throws IOException
```
    Converts the exception to a user-presentable error message. Specifically, extracts message field for HTTP 4xx codes, and creates a generic "Internal Server Error" for HTTP 5xx codes.
    
    Parameters:
    
    e - the exception
    
    action - the description of the action being performed at the time of error.
    
    Throws:
    
    IOException
    
    See Also:
    
    toUserPresentableMessage(IOException, String)
  - toUserPresentableMessage
```
public String toUserPresentableMessage(IOException e,
                                       @Nullable
                                       String action)
```
    Converts the exception to a user-presentable error message. Specifically, extracts message field for HTTP 4xx codes, and creates a generic "Internal Server Error" for HTTP 5xx codes.
  - toUserPresentableMessage
```
public String toUserPresentableMessage(IOException e)
```
    See toUserPresentableMessage(IOException, String).
  - getDebugInfo
```
@Nullable
public String getDebugInfo(IOException e)
```
  - getHttpStatusCode
```
protected int getHttpStatusCode(com.google.api.client.googleapis.json.GoogleJsonResponseException e)
```
    Returns HTTP status code from the given exception.
    Note: GoogleJsonResponseException.getStatusCode() method is marked final therefore it cannot be mocked using Mockito. We use this helper so that we can override it in tests.
  - getErrorInfo
```
@Nullable
protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo getErrorInfo(IOException e)
```
    Get the first ErrorInfo from an IOException if it is an instance of GoogleJsonResponseException, otherwise return null.
  - getJsonError
```
@Nullable
protected com.google.api.client.googleapis.json.GoogleJsonError getJsonError(IOException e)
```
    If the exception is a GoogleJsonResponseException, get the error details, else return null.
  - recursiveCheckForCode
```
protected boolean recursiveCheckForCode(IOException e,
                                        int code)
```
    Recursively checks getCause() if outer exception isn't an instance of the correct class.
  - getJsonResponseException
```
@Nullable
public static com.google.api.client.googleapis.json.GoogleJsonResponseException getJsonResponseException(Throwable throwable)
```

Class ApiErrorExtractor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

STATUS_CODE_RANGE_NOT_SATISFIABLE

GLOBAL_DOMAIN

USAGE_LIMITS_DOMAIN

RATE_LIMITED_REASON

USER_RATE_LIMITED_REASON

ACCOUNT_DISABLED_REASON

ACCESS_NOT_CONFIGURED_REASON

RESOURCE_NOT_READY_REASON

FIELD_SIZE_TOO_LARGE_REASON

USER_PROJECT_MISSING_MESSAGE

Constructor Detail

ApiErrorExtractor

Method Detail

requestFailure

accessDenied

badRequest

unauthorized

accessDeniedNonRecoverable

isClientError

clientError

internalServerError

itemAlreadyExists

itemNotFound

itemNotFound

fieldSizeTooLarge

resourceNotReady

preconditionNotMet

rangeNotSatisfiable

rateLimited

userProjectMissing

ioError

socketError

readTimedOut

getErrorMessage

toUserPresentableException

toUserPresentableMessage

toUserPresentableMessage

getDebugInfo

getHttpStatusCode

getErrorInfo

getJsonError

recursiveCheckForCode

getJsonResponseException