com.google.api.client.googleapis.services.protobuf

Class AbstractGoogleProtoClientRequest<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.protobuf.AbstractGoogleProtoClientRequest<T>

Type Parameters:

T - type of the response

All Implemented Interfaces:

Cloneable, Map<String,Object>

Direct Known Subclasses:

MockGoogleProtoClientRequest

@Beta
public abstract class AbstractGoogleProtoClientRequest<T>
extends AbstractGoogleClientRequest<T>

Beta
Google protocol buffer request for a AbstractGoogleProtoClient.

Implementation is not thread-safe.

Since:

1.16

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	AbstractGoogleProtoClientRequest(AbstractGoogleProtoClient abstractGoogleProtoClient, String requestMethod, String uriTemplate, com.google.protobuf.MessageLite message, Class<T> responseClass)

Method Summary

Modifier and Type	Method and Description
AbstractGoogleProtoClient	getAbstractGoogleClient() Returns the Google client.
Object	getMessage() Returns the message to serialize or null for none.
void	queue(BatchRequest batchRequest, BatchCallback<T,Void> callback) Queues the request into the specified batch request container.
AbstractGoogleProtoClientRequest<T>	set(String fieldName, Object value)
AbstractGoogleProtoClientRequest<T>	setDisableGZipContent(boolean disableGZipContent) Sets whether to disable GZip compression of HTTP content.
AbstractGoogleProtoClientRequest<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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, newExceptionOnError, queue

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

AbstractGoogleProtoClientRequest

protected AbstractGoogleProtoClientRequest(AbstractGoogleProtoClient abstractGoogleProtoClient,
                                           String requestMethod,
                                           String uriTemplate,
                                           com.google.protobuf.MessageLite message,
                                           Class<T> responseClass)

Parameters:

abstractGoogleProtoClient - Google protocol buffer 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)

message - message to serialize or null for none

responseClass - response class to parse into

Method Detail

getAbstractGoogleClient

public AbstractGoogleProtoClient 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 AbstractGoogleProtoClientRequest<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 AbstractGoogleProtoClientRequest<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,
                        BatchCallback<T,Void> 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 BatchCallback <SomeResponseType, Void >() {

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

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

Parameters:

batchRequest - batch request container

callback - batch callback

Throws:

IOException

getMessage

public Object getMessage()

Returns the message to serialize or null for none.

set

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

Overrides:

set in class AbstractGoogleClientRequest<T>