ApiErrorExtractor (util 1.4.5 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_CODE`
`static String`	`ACCOUNT_DISABLED_REASON_CODE`
`static String`	`FIELD_SIZE_TOO_LARGE`
`static String`	`GLOBAL_DOMAIN`
`static String`	`RATE_LIMITED_REASON_CODE`
`static String`	`RESOURCE_NOT_READY_REASON_CODE`
`static int`	`STATUS_CODE_CONFLICT`
`static int`	`STATUS_CODE_PRECONDITION_FAILED`
`static int`	`STATUS_CODE_RANGE_NOT_SATISFIABLE`
`static String`	`USAGE_LIMITS_DOMAIN`
`static String`	`USER_RATE_LIMITED_REASON_CODE`

Constructor Summary

Constructors
Constructor and Description

ApiErrorExtractor()

Constructors
Constructor and Description
`ApiErrorExtractor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accessDenied(IOException e)` Determines if the given exception indicates 'access denied'.
`boolean`	`accessDeniedNonRecoverable(com.google.api.client.googleapis.json.GoogleJsonError e)` Determine if a given GoogleJsonError is caused by, and only by, account disabled error.
`boolean`	`accessDeniedNonRecoverable(IOException e)` Determine if the exception is a non-recoverable access denied code (such as account closed or marked for deletion).
`boolean`	`fieldSizeTooLarge(com.google.api.client.googleapis.json.GoogleJsonError e)` Determines if the given GoogleJsonError indicates 'field size too large'.
`boolean`	`fieldSizeTooLarge(IOException e)` Determines if the given exception indicates 'field size too large'.
`protected com.google.api.client.googleapis.json.GoogleJsonError`	`getDetails(IOException e)` If the exception is a GoogleJsonResponseException, get the error details, else return null.
`protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo`	`getErrorInfo(com.google.api.client.googleapis.json.GoogleJsonError details)` Get the first ErrorInfo from a GoogleJsonError, or null if there is not one.
`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.
`boolean`	`ioError(Throwable throwable)` Determine if a given Throwable is caused by an IO error.
`boolean`	`isClientError(IOException e)` Determines if the exception is a client error.
`boolean`	`isInternalServerError(IOException e)` Determines if the exception is an internal server error.
`boolean`	`itemAlreadyExists(IOException e)` Determines if the given exception indicates 'item already exists'.
`boolean`	`itemNotFound(com.google.api.client.googleapis.json.GoogleJsonError e)` Determines if the given GoogleJsonError indicates 'item not found'.
`boolean`	`itemNotFound(IOException e)` Determines if the given exception indicates 'item not found'.
`boolean`	`preconditionNotMet(com.google.api.client.googleapis.json.GoogleJsonError e)` Determines if the given GoogleJsonError indicates 'precondition not met'
`boolean`	`preconditionNotMet(IOException e)` Determine 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(com.google.api.client.googleapis.json.GoogleJsonError e)` Determine if a given GoogleJsonError is caused by, and only by, a rate limit being applied.
`boolean`	`rateLimited(Throwable throwable)` Determine if a given Throwable is caused by a rate limit being applied.
`boolean`	`readTimedOut(IOException ex)` True if the exception is a "read timed out".
`protected boolean`	`recursiveCheckForCode(Throwable e, int code)` Recursively checks getCause() if outer exception isn't an instance of the correct class.
`boolean`	`resourceNotReady(com.google.api.client.googleapis.json.GoogleJsonError e)` Determines if the given GoogleJsonError indicates 'resource not ready'.
`boolean`	`resourceNotReady(IOException e)` Determines if the given exception indicates 'resource not ready'.
`boolean`	`socketError(Throwable throwable)` Determine if a given Throwable is caused by a socket error.
`IOException`	`toUserPresentableException(IOException ioe, String action)` Converts the exception to a user-presentable error message.
`String`	`toUserPresentableMessage(IOException ioe)`
`String`	`toUserPresentableMessage(IOException ioe, String action)` Converts the exception to a user-presentable error message.

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

- Field Detail
  - STATUS_CODE_CONFLICT
```
public static final int STATUS_CODE_CONFLICT
```
    See Also:
    
    Constant Field Values
  - STATUS_CODE_PRECONDITION_FAILED
```
public static final int STATUS_CODE_PRECONDITION_FAILED
```
    See Also:
    
    Constant Field Values
  - 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_CODE
```
public static final String RATE_LIMITED_REASON_CODE
```
    See Also:
    
    Constant Field Values
  - USER_RATE_LIMITED_REASON_CODE
```
public static final String USER_RATE_LIMITED_REASON_CODE
```
    See Also:
    
    Constant Field Values
  - ACCOUNT_DISABLED_REASON_CODE
```
public static final String ACCOUNT_DISABLED_REASON_CODE
```
    See Also:
    
    Constant Field Values
  - ACCESS_NOT_CONFIGURED_REASON_CODE
```
public static final String ACCESS_NOT_CONFIGURED_REASON_CODE
```
    See Also:
    
    Constant Field Values
  - RESOURCE_NOT_READY_REASON_CODE
```
public static final String RESOURCE_NOT_READY_REASON_CODE
```
    See Also:
    
    Constant Field Values
  - FIELD_SIZE_TOO_LARGE
```
public static final String FIELD_SIZE_TOO_LARGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ApiErrorExtractor
```
public ApiErrorExtractor()
```
- Method Detail
  - 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).
  - accessDeniedNonRecoverable
```
public boolean accessDeniedNonRecoverable(IOException e)
```
    Determine if the exception is a non-recoverable access denied code (such as account closed or marked for deletion).
  - accessDeniedNonRecoverable
```
public boolean accessDeniedNonRecoverable(com.google.api.client.googleapis.json.GoogleJsonError e)
```
    Determine if a given GoogleJsonError is caused by, and only by, account disabled error.
  - isClientError
```
public boolean isClientError(IOException e)
```
    Determines if the exception is a client error.
  - isInternalServerError
```
public boolean isInternalServerError(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
```
public boolean itemNotFound(com.google.api.client.googleapis.json.GoogleJsonError e)
```
    Determines if the given GoogleJsonError indicates 'item not found'.
  - 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(com.google.api.client.googleapis.json.GoogleJsonError e)
```
    Determines if the given GoogleJsonError indicates 'field size too large'.
  - 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(com.google.api.client.googleapis.json.GoogleJsonError e)
```
    Determines if the given GoogleJsonError indicates 'resource not ready'.
  - 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(com.google.api.client.googleapis.json.GoogleJsonError e)
```
    Determines if the given GoogleJsonError indicates 'precondition not met'
  - preconditionNotMet
```
public boolean preconditionNotMet(IOException e)
```
    Determine 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(com.google.api.client.googleapis.json.GoogleJsonError e)
```
    Determine if a given GoogleJsonError is caused by, and only by, a rate limit being applied.
    
    Parameters:
    
    e - The GoogleJsonError returned by the request
    
    Returns:
    
    True if the error is caused by a rate limit being applied.
  - rateLimited
```
public boolean rateLimited(Throwable throwable)
```
    Determine 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:
    
    throwable - The Throwable to check.
    
    Returns:
    
    True if the Throwable is a result of rate limiting being applied.
  - ioError
```
public boolean ioError(Throwable throwable)
```
    Determine 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)
```
    Determine 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 ex)
```
    True if the exception is a "read timed out".
  - getErrorMessage
```
public String getErrorMessage(IOException e)
```
    Extracts the error message.
  - toUserPresentableException
```
public IOException toUserPresentableException(IOException ioe,
                                              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:
    
    ioe - 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 ioe,
                                       @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 ioe)
```
    See Also:
    
    toUserPresentableMessage(IOException, String)
  - 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
```
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.
  - getDetails
```
protected com.google.api.client.googleapis.json.GoogleJsonError getDetails(IOException e)
```
    If the exception is a GoogleJsonResponseException, get the error details, else return null.
  - getErrorInfo
```
protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo getErrorInfo(com.google.api.client.googleapis.json.GoogleJsonError details)
```
    Get the first ErrorInfo from a GoogleJsonError, or null if there is not one.
  - recursiveCheckForCode
```
protected boolean recursiveCheckForCode(Throwable e,
                                        int code)
```
    Recursively checks getCause() if outer exception isn't an instance of the correct class.

Class ApiErrorExtractor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STATUS_CODE_CONFLICT

STATUS_CODE_PRECONDITION_FAILED

STATUS_CODE_RANGE_NOT_SATISFIABLE

GLOBAL_DOMAIN

USAGE_LIMITS_DOMAIN

RATE_LIMITED_REASON_CODE

USER_RATE_LIMITED_REASON_CODE

ACCOUNT_DISABLED_REASON_CODE

ACCESS_NOT_CONFIGURED_REASON_CODE

RESOURCE_NOT_READY_REASON_CODE

FIELD_SIZE_TOO_LARGE

Constructor Detail

ApiErrorExtractor

Method Detail

accessDenied

accessDeniedNonRecoverable

accessDeniedNonRecoverable

isClientError

isInternalServerError

itemAlreadyExists

itemNotFound

itemNotFound

fieldSizeTooLarge

fieldSizeTooLarge

resourceNotReady

resourceNotReady

preconditionNotMet

preconditionNotMet

rangeNotSatisfiable

rateLimited

rateLimited

ioError

socketError

readTimedOut

getErrorMessage

toUserPresentableException

toUserPresentableMessage

toUserPresentableMessage

getHttpStatusCode

getErrorInfo

getDetails

getErrorInfo

recursiveCheckForCode