com.google.api.client.googleapis.json

Class GoogleJsonError

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.client.googleapis.json.GoogleJsonError

All Implemented Interfaces:

Cloneable, Map<String,Object>

public class GoogleJsonError
extends GenericJson

Data class representing the Google JSON error response content, as documented for example in Error responses.

Since:

1.4

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoogleJsonError.Details
static class	GoogleJsonError.ErrorInfo Detailed error information.
static class	GoogleJsonError.ParameterViolations

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleJsonError()

Method Summary

Modifier and Type	Method and Description
GoogleJsonError	clone()
int	getCode() Returns the HTTP status code of this response or null for none.
List<GoogleJsonError.Details>	getDetails()
List<GoogleJsonError.ErrorInfo>	getErrors() Returns the list of detailed errors or null for none.
String	getMessage() Returns the human-readable explanation of the error or null for none.
static GoogleJsonError	parse(JsonFactory jsonFactory, HttpResponse response) Parses the given error HTTP response using the given JSON factory.
GoogleJsonError	set(String fieldName, Object value)
void	setCode(int code) Sets the HTTP status code of this response or null for none.
void	setDetails(List<GoogleJsonError.Details> details) Sets the list of invalid parameter error details as immutable to prevent exposing mutable state.
void	setErrors(List<GoogleJsonError.ErrorInfo> errors) Sets the list of detailed errors or null for none.
void	setMessage(String message) Sets the human-readable explanation of the error or null for none.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleJsonError

public GoogleJsonError()

Method Detail

parse

public static GoogleJsonError parse(JsonFactory jsonFactory,
                                    HttpResponse response)
                             throws IOException

Parses the given error HTTP response using the given JSON factory.

Parameters:

jsonFactory - JSON factory

response - HTTP response

Returns:

new instance of the Google JSON error information

Throws:

IllegalArgumentException - if content type is not Json.MEDIA_TYPE or if expected "data" or "error" key is not found

IOException

getErrors

public final List<GoogleJsonError.ErrorInfo> getErrors()

Returns the list of detailed errors or null for none.

Since:

1.8

setErrors

public final void setErrors(List<GoogleJsonError.ErrorInfo> errors)

Sets the list of detailed errors or null for none. Sets the list of detailed errors as immutable to prevent exposing mutable state.

Since:

1.8

getCode

public final int getCode()

Returns the HTTP status code of this response or null for none.

Since:

1.8

setCode

public final void setCode(int code)

Sets the HTTP status code of this response or null for none.

Since:

1.8

getMessage

public final String getMessage()

Returns the human-readable explanation of the error or null for none.

Since:

1.8

setMessage

public final void setMessage(String message)

Sets the human-readable explanation of the error or null for none.

Since:

1.8

getDetails

public List<GoogleJsonError.Details> getDetails()

setDetails

public void setDetails(List<GoogleJsonError.Details> details)

Sets the list of invalid parameter error details as immutable to prevent exposing mutable state.

Parameters:

details -

set

public GoogleJsonError set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public GoogleJsonError clone()

Overrides:

clone in class GenericJson