HttpRequest (google-http-client 1.14.0-beta)

java.lang.Object
- com.google.api.client.http.HttpRequest

```
public final class HttpRequest
extends Object
```
HTTP request.
Implementation is not thread-safe.

Since:

1.0

Author:

Yaniv Inbar

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`USER_AGENT_SUFFIX` User agent suffix for all requests.
`static String`	`VERSION` Current version of the Google API Client Library for Java.

Method Summary

Methods
Modifier and Type	Method and Description
`HttpResponse`	`execute()` Execute the HTTP request and returns the HTTP response.
`Future<HttpResponse>`	`executeAsync()` Executes this request asynchronously using `executeAsync(Executor)` in a single separate thread using `Executors.newSingleThreadExecutor()`.
`Future<HttpResponse>`	`executeAsync(Executor executor)` Executes this request asynchronously in a single separate thread using the supplied executor.
`BackOffPolicy`	`getBackOffPolicy()` Returns the `BackOffPolicy` to use between retry attempts or `null` for none.
`int`	`getConnectTimeout()` Returns the timeout in milliseconds to establish a connection or `0` for an infinite timeout.
`HttpContent`	`getContent()` Returns the HTTP request content or `null` for none.
`int`	`getContentLoggingLimit()` Returns the limit to the content size that will be logged during `execute()`.
`boolean`	`getEnableGZipContent()` Deprecated. (scheduled to be removed in 1.15) Use `getEncoding()` instead.
`HttpEncoding`	`getEncoding()` Returns the HTTP content encoding or `null` for none.
`boolean`	`getFollowRedirects()` Returns whether to follow redirects automatically.
`HttpHeaders`	`getHeaders()` Returns the HTTP request headers.
`HttpExecuteInterceptor`	`getInterceptor()` Returns the HTTP request execute interceptor to intercept the start of `execute()` (before executing the HTTP request) or `null` for none.
`int`	`getNumberOfRetries()` Returns the number of retries that will be allowed to execute as the result of an `HttpUnsuccessfulResponseHandler` before being terminated or `0` to not retry requests.
`ObjectParser`	`getParser()` Returns the `ObjectParser` used to parse the response or `null` for none.
`int`	`getReadTimeout()` Returns the timeout in milliseconds to read data from an established connection or `0` for an infinite timeout.
`String`	`getRequestMethod()` Returns the HTTP request method or `null` for none.
`HttpHeaders`	`getResponseHeaders()` Returns the HTTP response headers.
`HttpResponseInterceptor`	`getResponseInterceptor()` Returns the HTTP response interceptor or `null` for none.
`boolean`	`getRetryOnExecuteIOException()` Returns whether to retry the request if an `IOException` is encountered in `LowLevelHttpRequest.execute()`.
`boolean`	`getSuppressUserAgentSuffix()` Returns whether to not add the suffix `USER_AGENT_SUFFIX` to the User-Agent header.
`boolean`	`getThrowExceptionOnExecuteError()` Returns whether to throw an exception at the end of `execute()` on an HTTP error code (non-2XX) after all retries and response handlers have been exhausted.
`HttpTransport`	`getTransport()` Returns the HTTP transport.
`HttpUnsuccessfulResponseHandler`	`getUnsuccessfulResponseHandler()` Returns the HTTP unsuccessful (non-2XX) response handler or `null` for none.
`GenericUrl`	`getUrl()` Returns the HTTP request URL.
`boolean`	`handleRedirect(int statusCode, HttpHeaders responseHeaders)` Sets up this request object to handle the necessary redirect if redirects are turned on, it is a redirect status code and the header has a location.
`boolean`	`isCurlLoggingEnabled()` Returns whether logging in form of curl commands is enabled for this request.
`boolean`	`isLoggingEnabled()` Returns whether logging should be enabled for this request.
`HttpRequest`	`setBackOffPolicy(BackOffPolicy backOffPolicy)` Sets the `BackOffPolicy` to use between retry attempts or `null` for none.
`HttpRequest`	`setConnectTimeout(int connectTimeout)` Sets the timeout in milliseconds to establish a connection or `0` for an infinite timeout.
`HttpRequest`	`setContent(HttpContent content)` Sets the HTTP request content or `null` for none.
`HttpRequest`	`setContentLoggingLimit(int contentLoggingLimit)` Set the limit to the content size that will be logged during `execute()`.
`HttpRequest`	`setCurlLoggingEnabled(boolean curlLoggingEnabled)` Sets whether logging in form of curl commands should be enabled for this request.
`HttpRequest`	`setEnableGZipContent(boolean enableGZipContent)` Deprecated. (scheduled to be removed in 1.15) Use `setEncoding(HttpEncoding)` with `GZipEncoding` instead.
`HttpRequest`	`setEncoding(HttpEncoding encoding)` Sets the HTTP content encoding or `null` for none.
`HttpRequest`	`setFollowRedirects(boolean followRedirects)` Sets whether to follow redirects automatically.
`HttpRequest`	`setHeaders(HttpHeaders headers)` Sets the HTTP request headers.
`HttpRequest`	`setInterceptor(HttpExecuteInterceptor interceptor)` Sets the HTTP request execute interceptor to intercept the start of `execute()` (before executing the HTTP request) or `null` for none.
`HttpRequest`	`setLoggingEnabled(boolean loggingEnabled)` Sets whether logging should be enabled for this request.
`HttpRequest`	`setNumberOfRetries(int numRetries)` Returns the number of retries that will be allowed to execute as the result of an `HttpUnsuccessfulResponseHandler` before being terminated or `0` to not retry requests.
`HttpRequest`	`setParser(ObjectParser parser)` Sets the `ObjectParser` used to parse the response to this request or `null` for none.
`HttpRequest`	`setReadTimeout(int readTimeout)` Sets the timeout in milliseconds to read data from an established connection or `0` for an infinite timeout.
`HttpRequest`	`setRequestMethod(String requestMethod)` Sets the HTTP request method or `null` for none.
`HttpRequest`	`setResponseHeaders(HttpHeaders responseHeaders)` Sets the HTTP response headers.
`HttpRequest`	`setResponseInterceptor(HttpResponseInterceptor responseInterceptor)` Returns the HTTP response interceptor or `null` for none.
`HttpRequest`	`setRetryOnExecuteIOException(boolean retryOnExecuteIOException)` Sets whether to retry the request if an `IOException` is encountered in `LowLevelHttpRequest.execute()`.
`HttpRequest`	`setSuppressUserAgentSuffix(boolean suppressUserAgentSuffix)` Sets whether to not add the suffix `USER_AGENT_SUFFIX` to the User-Agent header.
`HttpRequest`	`setThrowExceptionOnExecuteError(boolean throwExceptionOnExecuteError)` Sets whether to throw an exception at the end of `execute()` on a HTTP error code (non-2XX) after all retries and response handlers have been exhausted.
`HttpRequest`	`setUnsuccessfulResponseHandler(HttpUnsuccessfulResponseHandler unsuccessfulResponseHandler)` Returns the HTTP unsuccessful (non-2XX) response handler or `null` for none.
`HttpRequest`	`setUrl(GenericUrl url)` Sets the HTTP request URL.

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

- Field Detail
  - VERSION
```
public static final String VERSION
```
    Current version of the Google API Client Library for Java.
    
    Since:
    
    1.8
    
    See Also:
    Constant Field Values
  - USER_AGENT_SUFFIX
```
public static final String USER_AGENT_SUFFIX
```
    User agent suffix for all requests.
    Includes a "(gzip)" suffix in case the server -- as Google's servers may do -- checks the User-Agent header to try to detect if the client accepts gzip-encoded responses.
    
    Since:
    
    1.4
    
    See Also:
    Constant Field Values
- Method Detail
  - getTransport
```
public HttpTransport getTransport()
```
    Returns the HTTP transport.
    
    Since:
    
    1.5
  - getRequestMethod
```
public String getRequestMethod()
```
    Returns the HTTP request method or null for none.
    
    Since:
    
    1.12
  - setRequestMethod
```
public HttpRequest setRequestMethod(String requestMethod)
```
    Sets the HTTP request method or null for none.
    
    Since:
    
    1.12
  - getUrl
```
public GenericUrl getUrl()
```
    Returns the HTTP request URL.
    
    Since:
    
    1.5
  - setUrl
```
public HttpRequest setUrl(GenericUrl url)
```
    Sets the HTTP request URL.
    
    Since:
    
    1.5
  - getContent
```
public HttpContent getContent()
```
    Returns the HTTP request content or null for none.
    
    Since:
    
    1.5
  - setContent
```
public HttpRequest setContent(HttpContent content)
```
    Sets the HTTP request content or null for none.
    
    Since:
    
    1.5
  - getEncoding
```
public HttpEncoding getEncoding()
```
    Returns the HTTP content encoding or null for none.
    
    Since:
    
    1.14
  - setEncoding
```
public HttpRequest setEncoding(HttpEncoding encoding)
```
    Sets the HTTP content encoding or null for none.
    
    Since:
    
    1.14
  - getEnableGZipContent
```
@Deprecated
public boolean getEnableGZipContent()
```
    Deprecated. (scheduled to be removed in 1.15) Use getEncoding() instead.
    
    Returns whether to enable gzip compression of HTTP content.
    
    Since:
    
    1.5
  - setEnableGZipContent
```
@Deprecated
public HttpRequest setEnableGZipContent(boolean enableGZipContent)
```
    Deprecated. (scheduled to be removed in 1.15) Use setEncoding(HttpEncoding) with GZipEncoding instead.
    Returns whether to enable gzip compression of HTTP content.
    By default it is false.
    
    To avoid the overhead of GZip compression for small content, one may want to set this to true only for HttpContent.getLength() above a certain limit. For example:
```
  public static class MyInterceptor implements HttpExecuteInterceptor {
    public void intercept(HttpRequest request) throws IOException {
      if (request.getContent() != null && request.getContent().getLength() >= 256) {
        request.setEnableGZipContent(true);
      }
    }
  }
 
```
    Warning: this will override any encoding for the request set in setEncoding(HttpEncoding)
    Since:
    
    1.5
  - getBackOffPolicy
```
public BackOffPolicy getBackOffPolicy()
```
    Returns the BackOffPolicy to use between retry attempts or null for none.
    
    Since:
    
    1.7
  - setBackOffPolicy
```
public HttpRequest setBackOffPolicy(BackOffPolicy backOffPolicy)
```
    Sets the BackOffPolicy to use between retry attempts or null for none.
    
    Since:
    
    1.7
  - getContentLoggingLimit
```
public int getContentLoggingLimit()
```
    Returns the limit to the content size that will be logged during execute().
    If the content size is greater than this limit then it will not be logged.
    
    Content will only be logged if isLoggingEnabled() is true.
    
    Can be set to 0 to disable content logging. This is useful for example if content has sensitive data such as authentication information.
    
    Defaults to 16KB.
    
    Since:
    
    1.7
  - setContentLoggingLimit
```
public HttpRequest setContentLoggingLimit(int contentLoggingLimit)
```
    Set the limit to the content size that will be logged during execute().
    If the content size is greater than this limit then it will not be logged.
    
    Content will only be logged if isLoggingEnabled() is true.
    
    Can be set to 0 to disable content logging. This is useful for example if content has sensitive data such as authentication information.
    
    Defaults to 16KB.
    
    Since:
    
    1.7
  - isLoggingEnabled
```
public boolean isLoggingEnabled()
```
    Returns whether logging should be enabled for this request.
    Defaults to true.
    
    Since:
    
    1.9
  - setLoggingEnabled
```
public HttpRequest setLoggingEnabled(boolean loggingEnabled)
```
    Sets whether logging should be enabled for this request.
    Defaults to true.
    
    Since:
    
    1.9
  - isCurlLoggingEnabled
```
public boolean isCurlLoggingEnabled()
```
    Returns whether logging in form of curl commands is enabled for this request.
    
    Since:
    
    1.11
  - setCurlLoggingEnabled
```
public HttpRequest setCurlLoggingEnabled(boolean curlLoggingEnabled)
```
    Sets whether logging in form of curl commands should be enabled for this request.
    Defaults to true.
    
    Since:
    
    1.11
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Returns the timeout in milliseconds to establish a connection or 0 for an infinite timeout.
    
    Since:
    
    1.5
  - setConnectTimeout
```
public HttpRequest setConnectTimeout(int connectTimeout)
```
    Sets the timeout in milliseconds to establish a connection or 0 for an infinite timeout.
    By default it is 20000 (20 seconds).
    
    Since:
    
    1.5
  - getReadTimeout
```
public int getReadTimeout()
```
    Returns the timeout in milliseconds to read data from an established connection or 0 for an infinite timeout.
    By default it is 20000 (20 seconds).
    
    Since:
    
    1.5
  - setReadTimeout
```
public HttpRequest setReadTimeout(int readTimeout)
```
    Sets the timeout in milliseconds to read data from an established connection or 0 for an infinite timeout.
    
    Since:
    
    1.5
  - getHeaders
```
public HttpHeaders getHeaders()
```
    Returns the HTTP request headers.
    
    Since:
    
    1.5
  - setHeaders
```
public HttpRequest setHeaders(HttpHeaders headers)
```
    Sets the HTTP request headers.
    By default, this is a new unmodified instance of HttpHeaders.
    
    Since:
    
    1.5
  - getResponseHeaders
```
public HttpHeaders getResponseHeaders()
```
    Returns the HTTP response headers.
    
    Since:
    
    1.5
  - setResponseHeaders
```
public HttpRequest setResponseHeaders(HttpHeaders responseHeaders)
```
    Sets the HTTP response headers.
    By default, this is a new unmodified instance of HttpHeaders.
    
    For example, this can be used if you want to use a subclass of HttpHeaders called MyHeaders to process the response:
```
  static String executeAndGetValueOfSomeCustomHeader(HttpRequest request) {
    MyHeaders responseHeaders = new MyHeaders();
    request.responseHeaders = responseHeaders;
    HttpResponse response = request.execute();
    return responseHeaders.someCustomHeader;
  }
 
```
    Since:
    
    1.5
  - getInterceptor
```
public HttpExecuteInterceptor getInterceptor()
```
    Returns the HTTP request execute interceptor to intercept the start of execute() (before executing the HTTP request) or null for none.
    
    Since:
    
    1.5
  - setInterceptor
```
public HttpRequest setInterceptor(HttpExecuteInterceptor interceptor)
```
    Sets the HTTP request execute interceptor to intercept the start of execute() (before executing the HTTP request) or null for none.
    
    Since:
    
    1.5
  - getUnsuccessfulResponseHandler
```
public HttpUnsuccessfulResponseHandler getUnsuccessfulResponseHandler()
```
    Returns the HTTP unsuccessful (non-2XX) response handler or null for none.
    
    Since:
    
    1.5
  - setUnsuccessfulResponseHandler
```
public HttpRequest setUnsuccessfulResponseHandler(HttpUnsuccessfulResponseHandler unsuccessfulResponseHandler)
```
    Returns the HTTP unsuccessful (non-2XX) response handler or null for none.
    
    Since:
    
    1.5
  - getResponseInterceptor
```
public HttpResponseInterceptor getResponseInterceptor()
```
    Returns the HTTP response interceptor or null for none.
    
    Since:
    
    1.13
  - setResponseInterceptor
```
public HttpRequest setResponseInterceptor(HttpResponseInterceptor responseInterceptor)
```
    Returns the HTTP response interceptor or null for none.
    
    Since:
    
    1.13
  - getNumberOfRetries
```
public int getNumberOfRetries()
```
    Returns the number of retries that will be allowed to execute as the result of an HttpUnsuccessfulResponseHandler before being terminated or 0 to not retry requests.
    
    Since:
    
    1.5
  - setNumberOfRetries
```
public HttpRequest setNumberOfRetries(int numRetries)
```
    Returns the number of retries that will be allowed to execute as the result of an HttpUnsuccessfulResponseHandler before being terminated or 0 to not retry requests.
    The default value is 10.
    
    Since:
    
    1.5
  - setParser
```
public HttpRequest setParser(ObjectParser parser)
```
    Sets the ObjectParser used to parse the response to this request or null for none.
    This parser will be preferred over any registered HttpParser.
    
    Since:
    
    1.10
  - getParser
```
public final ObjectParser getParser()
```
    Returns the ObjectParser used to parse the response or null for none.
    
    Since:
    
    1.10
  - getFollowRedirects
```
public boolean getFollowRedirects()
```
    Returns whether to follow redirects automatically.
    
    Since:
    
    1.6
  - setFollowRedirects
```
public HttpRequest setFollowRedirects(boolean followRedirects)
```
    Sets whether to follow redirects automatically.
    The default value is true.
    
    Since:
    
    1.6
  - getThrowExceptionOnExecuteError
```
public boolean getThrowExceptionOnExecuteError()
```
    Returns whether to throw an exception at the end of execute() on an HTTP error code (non-2XX) after all retries and response handlers have been exhausted.
    
    Since:
    
    1.7
  - setThrowExceptionOnExecuteError
```
public HttpRequest setThrowExceptionOnExecuteError(boolean throwExceptionOnExecuteError)
```
    Sets whether to throw an exception at the end of execute() on a HTTP error code (non-2XX) after all retries and response handlers have been exhausted.
    The default value is true.
    
    Since:
    
    1.7
  - getRetryOnExecuteIOException
```
public boolean getRetryOnExecuteIOException()
```
    Returns whether to retry the request if an IOException is encountered in LowLevelHttpRequest.execute().
    
    Since:
    
    1.9
  - setRetryOnExecuteIOException
```
public HttpRequest setRetryOnExecuteIOException(boolean retryOnExecuteIOException)
```
    Sets whether to retry the request if an IOException is encountered in LowLevelHttpRequest.execute().
    The default value is false.
    
    Since:
    
    1.9
  - getSuppressUserAgentSuffix
```
public boolean getSuppressUserAgentSuffix()
```
    Returns whether to not add the suffix USER_AGENT_SUFFIX to the User-Agent header.
    
    Since:
    
    1.11
  - setSuppressUserAgentSuffix
```
public HttpRequest setSuppressUserAgentSuffix(boolean suppressUserAgentSuffix)
```
    Sets whether to not add the suffix USER_AGENT_SUFFIX to the User-Agent header.
    The default value is false.
    
    Since:
    
    1.11
  - execute
```
public HttpResponse execute()
                     throws IOException
```
    Execute the HTTP request and returns the HTTP response.
    Note that regardless of the returned status code, the HTTP response content has not been parsed yet, and must be parsed by the calling code.
    Almost all details of the request and response are logged if Level.CONFIG is loggable. The only exception is the value of the Authorization header which is only logged if Level.ALL is loggable.
    Callers should call HttpResponse.disconnect() when the returned HTTP response object is no longer needed. However, HttpResponse.disconnect() does not have to be called if the response stream is properly closed. Example usage:
```
     HttpResponse response = request.execute();
     try {
       // process the HTTP response object
     } finally {
       response.disconnect();
     }
 
```
    Returns:
    HTTP response for an HTTP success response (or HTTP error response if getThrowExceptionOnExecuteError() is false)
    
    Throws:
    
    HttpResponseException - for an HTTP error response (only if getThrowExceptionOnExecuteError() is true)
    
    IOException
    See Also:
    HttpResponse.isSuccessStatusCode()
  - executeAsync
```
public Future<HttpResponse> executeAsync(Executor executor)
```
    Executes this request asynchronously in a single separate thread using the supplied executor.
    
    Parameters:
    executor - executor to run the asynchronous request
    
    Returns:
    future for accessing the HTTP response
    Since:
    
    1.13
  - executeAsync
```
public Future<HttpResponse> executeAsync()
```
    Executes this request asynchronously using executeAsync(Executor) in a single separate thread using Executors.newSingleThreadExecutor().
    
    Returns:
    A future for accessing the results of the asynchronous request.
    Since:
    
    1.13
  - handleRedirect
```
public boolean handleRedirect(int statusCode,
                     HttpHeaders responseHeaders)
```
    Sets up this request object to handle the necessary redirect if redirects are turned on, it is a redirect status code and the header has a location.
    When the status code is 303 the method on the request is changed to a GET as per the RFC2616 specification. On a redirect, it also removes the "Authorization" and all "If-*" request headers.
    
    Upgrade warning: in prior version 1.13 all request headers were retained, but starting with version 1.14 it now removes the "Authorization" and all "If-*" request headers.
    
    Returns:
    whether the redirect was successful
    Since:
    
    1.11

Class HttpRequest

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

USER_AGENT_SUFFIX

Method Detail

getTransport

getRequestMethod

setRequestMethod

getUrl

setUrl

getContent

setContent

getEncoding

setEncoding

getEnableGZipContent

setEnableGZipContent

getBackOffPolicy

setBackOffPolicy

getContentLoggingLimit

setContentLoggingLimit

isLoggingEnabled

setLoggingEnabled

isCurlLoggingEnabled

setCurlLoggingEnabled

getConnectTimeout

setConnectTimeout

getReadTimeout

setReadTimeout

getHeaders

setHeaders

getResponseHeaders

setResponseHeaders

getInterceptor

setInterceptor

getUnsuccessfulResponseHandler

setUnsuccessfulResponseHandler

getResponseInterceptor

setResponseInterceptor

getNumberOfRetries

setNumberOfRetries

setParser

getParser

getFollowRedirects

setFollowRedirects

getThrowExceptionOnExecuteError

setThrowExceptionOnExecuteError

getRetryOnExecuteIOException

setRetryOnExecuteIOException

getSuppressUserAgentSuffix

setSuppressUserAgentSuffix

execute

executeAsync

executeAsync

handleRedirect