com.google.maps

Class GeoApiContext

java.lang.Object

com.google.maps.GeoApiContext

public class GeoApiContext
extends java.lang.Object

The entry point for making requests against the Google Geo APIs.

Constructor Summary

Constructors

Constructor and Description
GeoApiContext()

Method Summary

Methods

Modifier and Type	Method and Description
GeoApiContext	setApiKey(java.lang.String apiKey)
GeoApiContext	setConnectTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the default connect timeout for new connections.
GeoApiContext	setEnterpriseCredentials(java.lang.String clientId, java.lang.String cryptographicSecret)
GeoApiContext	setProxy(java.net.Proxy proxy) Sets the proxy for new connections.
GeoApiContext	setQueryRateLimit(int maxQps) Sets the maximum number of queries that will be executed during a 1 second interval.
GeoApiContext	setQueryRateLimit(int maxQps, int minimumInterval) Sets the rate at which queries are executed.
GeoApiContext	setReadTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the default read timeout for new connections.
GeoApiContext	setRetryTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the time limit for which retry-able errors will be retried.
GeoApiContext	setWriteTimeout(long timeout, java.util.concurrent.TimeUnit unit) Sets the default write timeout for new connections.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoApiContext

public GeoApiContext()

Method Detail

setApiKey

public GeoApiContext setApiKey(java.lang.String apiKey)

setEnterpriseCredentials

public GeoApiContext setEnterpriseCredentials(java.lang.String clientId,
                                     java.lang.String cryptographicSecret)

setConnectTimeout

public GeoApiContext setConnectTimeout(long timeout,
                              java.util.concurrent.TimeUnit unit)

Sets the default connect timeout for new connections. A value of 0 means no timeout.

See Also:

URLConnection.setConnectTimeout(int)

setReadTimeout

public GeoApiContext setReadTimeout(long timeout,
                           java.util.concurrent.TimeUnit unit)

Sets the default read timeout for new connections. A value of 0 means no timeout.

See Also:

URLConnection.setReadTimeout(int)

setWriteTimeout

public GeoApiContext setWriteTimeout(long timeout,
                            java.util.concurrent.TimeUnit unit)

Sets the default write timeout for new connections. A value of 0 means no timeout.

setRetryTimeout

public GeoApiContext setRetryTimeout(long timeout,
                            java.util.concurrent.TimeUnit unit)

Sets the time limit for which retry-able errors will be retried. Defaults to 60 seconds. Set to zero to disable.

setQueryRateLimit

public GeoApiContext setQueryRateLimit(int maxQps)

Sets the maximum number of queries that will be executed during a 1 second interval. The default is 10. A minimum interval between requests will also be enforced, set to 1/(2 * maxQps).

setQueryRateLimit

public GeoApiContext setQueryRateLimit(int maxQps,
                              int minimumInterval)

Sets the rate at which queries are executed.

Parameters:

maxQps - The maximum number of queries to execute per second.

minimumInterval - The minimum amount of time, in milliseconds, to pause between requests. Note that this pause only occurs if the amount of time between requests has not elapsed naturally.

setProxy

public GeoApiContext setProxy(java.net.Proxy proxy)

Sets the proxy for new connections.

Parameters:

proxy - The proxy to be used by the underlying HTTP client.