Google_Service_MapsEngine_Rasters_Resource Class Reference

The "rasters" collection of methods. More...

Inheritance diagram for Google_Service_MapsEngine_Rasters_Resource:

Public Member Functions
	call ($name, $arguments, $expected_class=null)
	TODO: This function needs simplifying.
	delete ($id, $optParams=array())
	Delete a raster.
	get ($id, $optParams=array())
	Return metadata for a single raster.
	listRasters ($projectId, $optParams=array())
	Return all rasters readable by the current user.
	patch ($id, Google_Service_MapsEngine_Raster $postBody, $optParams=array())
	Mutate a raster asset.
	process ($id, $optParams=array())
	Process a raster asset.
	upload (Google_Service_MapsEngine_Raster $postBody, $optParams=array())
	Create a skeleton raster asset for upload.

Protected Member Functions
	convertToArrayAndStripNulls ($o)

Detailed Description

The "rasters" collection of methods.

Typical usage is: $mapsengineService = new Google_Service_MapsEngine(...); $rasters = $mapsengineService->rasters;

Member Function Documentation

call()

Google_Service_Resource::call ( $name, $arguments, $expected_class = null )

inherited

TODO: This function needs simplifying.

Parameters

$name
$arguments
$expected_class	- optional, the expected class name

Return values

Google_Http_Request|expected_class

Exceptions

Google_Exception

delete()

Google_Service_MapsEngine_Rasters_Resource::delete	(		$id,
			$optParams = array() )

Delete a raster.

(rasters.delete)

Parameters

string	$id	The ID of the raster. Only the raster creator or project owner are permitted to delete. If the raster is included in a layer or mosaic, the request will fail. Remove it from all parents prior to deleting.
array	$optParams	Optional parameters.

get()

Google_Service_MapsEngine_Rasters_Resource::get	(		$id,
			$optParams = array() )

Return metadata for a single raster.

(rasters.get)

Parameters

string	$id	The ID of the raster.
array	$optParams	Optional parameters.

Return values

Google_Service_MapsEngine_Raster

listRasters()

Google_Service_MapsEngine_Rasters_Resource::listRasters	(		$projectId,
			$optParams = array() )

Return all rasters readable by the current user.

(rasters.listRasters)

Parameters

string	$projectId	The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
array	$optParams	Optional parameters.

@opt_param string 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. @opt_param string 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. @opt_param string processingStatus @opt_param string tags A comma separated list of tags. Returned assets will contain all the tags from the list. @opt_param string search An unstructured search string used to filter the set of results based on asset metadata. @opt_param string maxResults The maximum number of items to include in a single response page. The maximum supported value is 100. @opt_param 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. @opt_param string creatorEmail An email address representing a user. Returned assets that have been created by the user associated with the provided email address. @opt_param string bbox A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned. @opt_param string 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. @opt_param string 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. @opt_param string role The role parameter indicates that the response should only contain assets where the current user has the specified level of access.

Return values

Google_Service_MapsEngine_RastersListResponse

patch()

Google_Service_MapsEngine_Rasters_Resource::patch	(		$id,
		Google_Service_MapsEngine_Raster	$postBody,
			$optParams = array() )

Mutate a raster asset.

(rasters.patch)

Parameters

string	$id	The ID of the raster.
Google_Raster	$postBody
array	$optParams	Optional parameters.

process()

Google_Service_MapsEngine_Rasters_Resource::process	(		$id,
			$optParams = array() )

Process a raster asset.

(rasters.process)

Parameters

string	$id	The ID of the raster.
array	$optParams	Optional parameters.

Return values

Google_Service_MapsEngine_ProcessResponse

upload()

Google_Service_MapsEngine_Rasters_Resource::upload	(	Google_Service_MapsEngine_Raster	$postBody,
			$optParams = array() )

Create a skeleton raster asset for upload.

(rasters.upload)

Parameters

Google_Raster	$postBody
array	$optParams	Optional parameters.

Return values

Google_Service_MapsEngine_Raster

---

The documentation for this class was generated from the following file:

• lib/google/src/Google/Service/MapsEngine.php