com.google.api.client.googleapis.services.json

Class AbstractGoogleJsonClientRequest<T>

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

Type Parameters:

T - type of the response

All Implemented Interfaces:

Cloneable, Map<String,Object>

Direct Known Subclasses:

MockGoogleJsonClientRequest

public abstract class AbstractGoogleJsonClientRequest<T>
extends AbstractGoogleClientRequest<T>

Google JSON request for a AbstractGoogleJsonClient.

Implementation is not thread-safe.

Since:

1.12

Author:

Yaniv Inbar

Nested Class Summary

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

com.google.api.client.util.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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGoogleJsonClientRequest(AbstractGoogleJsonClient abstractGoogleJsonClient, String requestMethod, String uriTemplate, Object jsonContent, Class<T> responseClass)

Method Summary

Modifier and Type	Method and Description
AbstractGoogleJsonClient	getAbstractGoogleClient() Returns the Google client.
Object	getJsonContent() Returns POJO that can be serialized into JSON content or null for none.
protected GoogleJsonResponseException	newExceptionOnError(com.google.api.client.http.HttpResponse response) Returns the exception to throw on an HTTP error response as defined by HttpResponse.isSuccessStatusCode().
void	queue(BatchRequest batchRequest, JsonBatchCallback<T> callback) Queues the request into the specified batch request container.
AbstractGoogleJsonClientRequest<T>	set(String fieldName, Object value)
AbstractGoogleJsonClientRequest<T>	setDisableGZipContent(boolean disableGZipContent) Sets whether to disable GZip compression of HTTP content.
AbstractGoogleJsonClientRequest<T>	setRequestHeaders(com.google.api.client.http.HttpHeaders headers) Sets the HTTP headers used for the Google client request.

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

AbstractGoogleJsonClientRequest

protected AbstractGoogleJsonClientRequest(AbstractGoogleJsonClient abstractGoogleJsonClient,
                                          String requestMethod,
                                          String uriTemplate,
                                          Object jsonContent,
                                          Class<T> responseClass)

Parameters:

abstractGoogleJsonClient - Google JSON client

requestMethod - HTTP Method

uriTemplate - URI template for the path relative to the base URL. If it starts with a "/" the base path from the base URL will be stripped out. The URI template can also be a full URL. URI template expansion is done using UriTemplate.expand(String, String, Object, boolean)

jsonContent - POJO that can be serialized into JSON content or null for none

responseClass - response class to parse into

Method Detail

getAbstractGoogleClient

public AbstractGoogleJsonClient getAbstractGoogleClient()

Description copied from class: AbstractGoogleClientRequest

Returns the Google client.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

getAbstractGoogleClient in class AbstractGoogleClientRequest<T>

setDisableGZipContent

public AbstractGoogleJsonClientRequest<T> setDisableGZipContent(boolean disableGZipContent)

Description copied from class: AbstractGoogleClientRequest

Sets whether to disable GZip compression of HTTP content.

By default it is false.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setDisableGZipContent in class AbstractGoogleClientRequest<T>

setRequestHeaders

public AbstractGoogleJsonClientRequest<T> setRequestHeaders(com.google.api.client.http.HttpHeaders headers)

Description copied from class: AbstractGoogleClientRequest

Sets the HTTP headers used for the Google client request.

These headers are set on the request after AbstractGoogleClientRequest.buildHttpRequest() is called, this means that HttpRequestInitializer.initialize(com.google.api.client.http.HttpRequest) is called first.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setRequestHeaders in class AbstractGoogleClientRequest<T>

queue

public final void queue(BatchRequest batchRequest,
                        JsonBatchCallback<T> callback)
                 throws IOException

Queues the request into the specified batch request container.

Batched requests are then executed when BatchRequest.execute() is called.

Example usage:

 request.queue(batchRequest, new JsonBatchCallback<SomeResponseType>() {

   public void onSuccess(SomeResponseType content, HttpHeaders responseHeaders) {
     log("Success");
   }

   public void onFailure(GoogleJsonError e, HttpHeaders responseHeaders) {
     log(e.getMessage());
   }
 });
 

Parameters:

batchRequest - batch request container

callback - batch callback

Throws:

IOException

newExceptionOnError

protected GoogleJsonResponseException newExceptionOnError(com.google.api.client.http.HttpResponse response)

Description copied from class: AbstractGoogleClientRequest

Returns the exception to throw on an HTTP error response as defined by HttpResponse.isSuccessStatusCode().

It is guaranteed that HttpResponse.isSuccessStatusCode() is false. Default implementation is to call HttpResponseException(HttpResponse), but subclasses may override.

Overrides:

newExceptionOnError in class AbstractGoogleClientRequest<T>

Parameters:

response - HTTP response

Returns:

exception to throw

getJsonContent

public Object getJsonContent()

Returns POJO that can be serialized into JSON content or null for none.

set

public AbstractGoogleJsonClientRequest<T> set(String fieldName,
                                              Object value)

Overrides:

set in class AbstractGoogleClientRequest<T>