com.google.api.services.mapsengine

Class MapsEngine.RasterCollections.Rasters.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.mapsengine.MapsEngineRequest<RasterCollectionsRastersListResponse>

com.google.api.services.mapsengine.MapsEngine.RasterCollections.Rasters.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

MapsEngine.RasterCollections.Rasters

public class MapsEngine.RasterCollections.Rasters.List
extends MapsEngineRequest<RasterCollectionsRastersListResponse>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapsEngine.RasterCollections.Rasters.List(java.lang.String id) Return all rasters within a raster collection.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getBbox() A bounding box, expressed as "west,south,east,north".
com.google.api.client.util.DateTime	getCreatedAfter() An RFC 3339 formatted date-time value (e.g.
com.google.api.client.util.DateTime	getCreatedBefore() An RFC 3339 formatted date-time value (e.g.
java.lang.String	getCreatorEmail() An email address representing a user.
java.lang.String	getId() The ID of the raster collection to which these rasters belong.
java.lang.Long	getMaxResults() The maximum number of items to include in a single response page.
com.google.api.client.util.DateTime	getModifiedAfter() An RFC 3339 formatted date-time value (e.g.
com.google.api.client.util.DateTime	getModifiedBefore() An RFC 3339 formatted date-time value (e.g.
java.lang.String	getPageToken() The continuation token, used to page through large result sets.
java.lang.String	getRole() The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
java.lang.String	getSearch() An unstructured search string used to filter the set of results based on asset metadata.
java.lang.String	getTags() A comma separated list of tags.
MapsEngine.RasterCollections.Rasters.List	set(java.lang.String parameterName, java.lang.Object value)
MapsEngine.RasterCollections.Rasters.List	setAlt(java.lang.String alt) Data format for the response.
MapsEngine.RasterCollections.Rasters.List	setBbox(java.lang.String bbox) A bounding box, expressed as "west,south,east,north".
MapsEngine.RasterCollections.Rasters.List	setCreatedAfter(com.google.api.client.util.DateTime createdAfter) An RFC 3339 formatted date-time value (e.g.
MapsEngine.RasterCollections.Rasters.List	setCreatedBefore(com.google.api.client.util.DateTime createdBefore) An RFC 3339 formatted date-time value (e.g.
MapsEngine.RasterCollections.Rasters.List	setCreatorEmail(java.lang.String creatorEmail) An email address representing a user.
MapsEngine.RasterCollections.Rasters.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
MapsEngine.RasterCollections.Rasters.List	setId(java.lang.String id) The ID of the raster collection to which these rasters belong.
MapsEngine.RasterCollections.Rasters.List	setKey(java.lang.String key) API key.
MapsEngine.RasterCollections.Rasters.List	setMaxResults(java.lang.Long maxResults) The maximum number of items to include in a single response page.
MapsEngine.RasterCollections.Rasters.List	setModifiedAfter(com.google.api.client.util.DateTime modifiedAfter) An RFC 3339 formatted date-time value (e.g.
MapsEngine.RasterCollections.Rasters.List	setModifiedBefore(com.google.api.client.util.DateTime modifiedBefore) An RFC 3339 formatted date-time value (e.g.
MapsEngine.RasterCollections.Rasters.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
MapsEngine.RasterCollections.Rasters.List	setPageToken(java.lang.String pageToken) The continuation token, used to page through large result sets.
MapsEngine.RasterCollections.Rasters.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
MapsEngine.RasterCollections.Rasters.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
MapsEngine.RasterCollections.Rasters.List	setRole(java.lang.String role) The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
MapsEngine.RasterCollections.Rasters.List	setSearch(java.lang.String search) An unstructured search string used to filter the set of results based on asset metadata.
MapsEngine.RasterCollections.Rasters.List	setTags(java.lang.String tags) A comma separated list of tags.
MapsEngine.RasterCollections.Rasters.List	setUserIp(java.lang.String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.mapsengine.MapsEngineRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

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

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MapsEngine.RasterCollections.Rasters.List

protected MapsEngine.RasterCollections.Rasters.List(java.lang.String id)

Return all rasters within a raster collection. Create a request for the method "rasters.list". This request holds the parameters needed by the the mapsengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

MapsEngine.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

id - The ID of the raster collection to which these rasters belong.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RasterCollectionsRastersListResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<RasterCollectionsRastersListResponse>

Throws:

java.io.IOException

setAlt

public MapsEngine.RasterCollections.Rasters.List setAlt(java.lang.String alt)

Description copied from class: MapsEngineRequest

Data format for the response.

Overrides:

setAlt in class MapsEngineRequest<RasterCollectionsRastersListResponse>

setFields

public MapsEngine.RasterCollections.Rasters.List setFields(java.lang.String fields)

Description copied from class: MapsEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class MapsEngineRequest<RasterCollectionsRastersListResponse>

setKey

public MapsEngine.RasterCollections.Rasters.List setKey(java.lang.String key)

Description copied from class: MapsEngineRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class MapsEngineRequest<RasterCollectionsRastersListResponse>

setOauthToken

public MapsEngine.RasterCollections.Rasters.List setOauthToken(java.lang.String oauthToken)

Description copied from class: MapsEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class MapsEngineRequest<RasterCollectionsRastersListResponse>

setPrettyPrint

public MapsEngine.RasterCollections.Rasters.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: MapsEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class MapsEngineRequest<RasterCollectionsRastersListResponse>

setQuotaUser

public MapsEngine.RasterCollections.Rasters.List setQuotaUser(java.lang.String quotaUser)

Description copied from class: MapsEngineRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class MapsEngineRequest<RasterCollectionsRastersListResponse>

setUserIp

public MapsEngine.RasterCollections.Rasters.List setUserIp(java.lang.String userIp)

Description copied from class: MapsEngineRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class MapsEngineRequest<RasterCollectionsRastersListResponse>

getId

public java.lang.String getId()

The ID of the raster collection to which these rasters belong.

setId

public MapsEngine.RasterCollections.Rasters.List setId(java.lang.String id)

The ID of the raster collection to which these rasters belong.

getModifiedAfter

public com.google.api.client.util.DateTime getModifiedAfter()

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.

setModifiedAfter

public MapsEngine.RasterCollections.Rasters.List setModifiedAfter(com.google.api.client.util.DateTime modifiedAfter)

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.

getCreatedAfter

public com.google.api.client.util.DateTime getCreatedAfter()

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.

setCreatedAfter

public MapsEngine.RasterCollections.Rasters.List setCreatedAfter(com.google.api.client.util.DateTime createdAfter)

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.

getTags

public java.lang.String getTags()

A comma separated list of tags. Returned assets will contain all the tags from the list.

setTags

public MapsEngine.RasterCollections.Rasters.List setTags(java.lang.String tags)

A comma separated list of tags. Returned assets will contain all the tags from the list.

getSearch

public java.lang.String getSearch()

An unstructured search string used to filter the set of results based on asset metadata.

setSearch

public MapsEngine.RasterCollections.Rasters.List setSearch(java.lang.String search)

An unstructured search string used to filter the set of results based on asset metadata.

getMaxResults

public java.lang.Long getMaxResults()

The maximum number of items to include in a single response page. The maximum supported value is 100.

setMaxResults

public MapsEngine.RasterCollections.Rasters.List setMaxResults(java.lang.Long maxResults)

The maximum number of items to include in a single response page. The maximum supported value is 100.

getPageToken

public java.lang.String getPageToken()

The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

setPageToken

public MapsEngine.RasterCollections.Rasters.List setPageToken(java.lang.String pageToken)

The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

getCreatorEmail

public java.lang.String getCreatorEmail()

An email address representing a user. Returned assets that have been created by the user associated with the provided email address.

setCreatorEmail

public MapsEngine.RasterCollections.Rasters.List setCreatorEmail(java.lang.String creatorEmail)

An email address representing a user. Returned assets that have been created by the user associated with the provided email address.

getBbox

public java.lang.String getBbox()

A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.

setBbox

public MapsEngine.RasterCollections.Rasters.List setBbox(java.lang.String bbox)

A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.

getModifiedBefore

public com.google.api.client.util.DateTime getModifiedBefore()

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.

setModifiedBefore

public MapsEngine.RasterCollections.Rasters.List setModifiedBefore(com.google.api.client.util.DateTime modifiedBefore)

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.

getCreatedBefore

public com.google.api.client.util.DateTime getCreatedBefore()

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.

setCreatedBefore

public MapsEngine.RasterCollections.Rasters.List setCreatedBefore(com.google.api.client.util.DateTime createdBefore)

An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.

getRole

public java.lang.String getRole()

The role parameter indicates that the response should only contain assets where the current user has the specified level of access.

setRole

public MapsEngine.RasterCollections.Rasters.List setRole(java.lang.String role)

The role parameter indicates that the response should only contain assets where the current user has the specified level of access.

set

public MapsEngine.RasterCollections.Rasters.List set(java.lang.String parameterName,
                                            java.lang.Object value)

Overrides:

set in class MapsEngineRequest<RasterCollectionsRastersListResponse>