com.google.api.client.googleapis

Class GoogleUrl

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.http.GenericUrl

com.google.api.client.googleapis.GoogleUrl

All Implemented Interfaces:

Cloneable, Map<String,Object>

public class GoogleUrl
extends GenericUrl

Generic Google URL providing for some common query parameters used in Google API's such as the alt and fields parameters.

Implementation is not thread-safe.

Since:

1.0

Author:

Yaniv Inbar

Nested Class Summary

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

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>

Constructor Summary

Constructors

Constructor and Description
GoogleUrl()
GoogleUrl(String encodedUrl)

Method Summary

Methods

Modifier and Type	Method and Description
GoogleUrl	clone()
String	getAlt() Returns the alternate wire format.
String	getFields() Returns the partial fields mask.
String	getKey() Returns the API key as described in the Google APIs Console documentation.
Boolean	getPrettyPrint() Returns whether to pretty print the output.
String	getUserIp() Returns the user IP used to enforce per-user limits for server-side applications, as described in the Google APIs Console documentation.
void	setAlt(String alt) Sets the alternate wire format.
void	setFields(String fields) Sets the partial fields mask.
void	setKey(String key) Sets the API key as described in the Google APIs Console documentation.
void	setPrettyPrint(Boolean prettyPrint) Sets whether to pretty print the output.
void	setUserIp(String userip) Sets the user IP used to enforce per-user limits for server-side applications, as described in the Google APIs Console documentation.

Methods inherited from class com.google.api.client.http.GenericUrl

appendRawPath, build, buildAuthority, buildRelativeUrl, equals, getAll, getFirst, getFragment, getHost, getPathParts, getPort, getRawPath, getScheme, hashCode, setFragment, setHost, setPathParts, setPort, setRawPath, setScheme, toPathParts, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, setUnknownKeys

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

Constructor Detail

GoogleUrl

public GoogleUrl()

GoogleUrl

public GoogleUrl(String encodedUrl)

Parameters:

encodedUrl - encoded URL, including any existing query parameters that should be parsed

Method Detail

clone

public GoogleUrl clone()

Overrides:

clone in class GenericUrl

getPrettyPrint

public Boolean getPrettyPrint()

Returns whether to pretty print the output.

Since:

1.8

setPrettyPrint

public void setPrettyPrint(Boolean prettyPrint)

Sets whether to pretty print the output.

Since:

1.8

getAlt

public final String getAlt()

Returns the alternate wire format.

Since:

1.8

setAlt

public final void setAlt(String alt)

Sets the alternate wire format.

Since:

1.8

getFields

public final String getFields()

Returns the partial fields mask.

Since:

1.8

setFields

public final void setFields(String fields)

Sets the partial fields mask.

Since:

1.8

getKey

public final String getKey()

Returns the API key as described in the Google APIs Console documentation.

Since:

1.8

setKey

public final void setKey(String key)

Sets the API key as described in the Google APIs Console documentation.

Since:

1.8

getUserIp

public final String getUserIp()

Returns the user IP used to enforce per-user limits for server-side applications, as described in the Google APIs Console documentation.

Since:

1.8

setUserIp

public final void setUserIp(String userip)

Sets the user IP used to enforce per-user limits for server-side applications, as described in the Google APIs Console documentation.

Since:

1.8