Class AbstractGoogleClientRequest<T> (2.6.0)

Abstract Google client request for a AbstractGoogleClient.

Implementation is not thread-safe.

The generated request class will pass this constant as part of the header if the RPC supports ApiVersion.

User agent suffix for all requests.

Queues the request into the specified batch request container using the specified error class.

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

Create a request suitable for use against this service.

Subclasses may override by calling the super implementation.

Creates a new instance of GenericUrl suitable for use against this service.

Subclasses may override by calling the super implementation.

Create a request suitable for use against this service, but using HEAD instead of GET.

Only supported when the original request method is GET.

Subclasses may override by calling the super implementation.

Ensures that the specified required parameter is not null or AbstractGoogleClient#getSuppressRequiredParameterChecks() is true.

Sends the metadata request to the server and returns the parsed metadata response.

Subclasses may override by calling the super implementation.

Sends the metadata request to the server and writes the metadata content input stream of HttpResponse into the given destination output stream.

This method closes the content of the HTTP response from HttpResponse#getContent().

Subclasses may override by calling the super implementation.

Sends the metadata request to the server and returns the metadata content input stream of HttpResponse.

Callers are responsible for closing the input stream after it is processed. Example sample:

 InputStream is = request.executeAsInputStream();
 try {
   // Process input stream..
 } finally {
   is.close();
 }
 

Subclasses may override by calling the super implementation.

Sends the media request to the server and returns the raw media HttpResponse.

Callers are responsible for disconnecting the HTTP response by calling HttpResponse#disconnect. Example usage:

 HttpResponse response = request.executeMedia();
 try {
   // process response..
 } finally {
   response.disconnect();
 }
 

Subclasses may override by calling the super implementation.

Sends the media request to the server and writes the media content input stream of HttpResponse into the given destination output stream.

This method closes the content of the HTTP response from HttpResponse#getContent().

Subclasses may override by calling the super implementation.

Sends the media request to the server and returns the media content input stream of HttpResponse.

Callers are responsible for closing the input stream after it is processed. Example sample:

 InputStream is = request.executeMediaAsInputStream();
 try {
   // Process input stream..
 } finally {
   is.close();
 }
 

Subclasses may override by calling the super implementation.

Sends the metadata request to the server and returns the raw metadata HttpResponse.

Callers are responsible for disconnecting the HTTP response by calling HttpResponse#disconnect. Example usage:

 HttpResponse response = request.executeUnparsed();
 try {
   // process response..
 } finally {
   response.disconnect();
 }
 

Subclasses may override by calling the super implementation.

Sends the metadata request using HEAD to the server and returns the raw metadata HttpResponse for the response headers.

Only supported when the original request method is GET. The response content is assumed to be empty and ignored. Calls HttpResponse#ignore() so there is no need to disconnect the response. Example usage:

 HttpResponse response = request.executeUsingHead();
 // look at response.getHeaders()
 

Subclasses may override by calling the super implementation.

Returns the Google client.

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

Returns whether to disable GZip compression of HTTP content.

Returns the HTTP content or null for none.

Returns the HTTP headers of the last response or null before request has been executed.

Returns the status code of the last response or -1 before request has been executed.

Returns the status message of the last response or null before request has been executed.

Returns the media HTTP downloader or null for none.

Returns the media HTTP Uploader or null for none.

Returns the HTTP headers used for the Google client request.

Returns the HTTP method.

Returns the response class to parse into.

Returns whether response should return raw input stream.

Returns the URI template for the path relative to the base URL.

Initializes the media HTTP downloader.

Initializes the media HTTP uploader based on the media content.

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#HttpResponseException(HttpResponse), but subclasses may override.

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.

Sets the HTTP headers used for the Google client request.

These headers are set on the request after #buildHttpRequest is called, this means that HttpRequestInitializer#initialize is called first.

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

Sets whether the response should return raw input stream or not.

By default it is false.

When the response contains a known content-encoding header, the response stream is wrapped with an InputStream that decodes the content. This fails when we download large files in chunks (see #1009 ). Setting this to true will make the response return the raw input stream.