Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
Google_Service_MapsEngine_RasterCollectionsRasters_Resource Class Reference

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

Inheritance diagram for Google_Service_MapsEngine_RasterCollectionsRasters_Resource:
Google_Service_Resource

Public Member Functions

 batchDelete ($id, Google_Service_MapsEngine_RasterCollectionsRasterBatchDeleteRequest $postBody, $optParams=array())
 Remove rasters from an existing raster collection.
 
 batchInsert ($id, Google_Service_MapsEngine_RasterCollectionsRastersBatchInsertRequest $postBody, $optParams=array())
 Add rasters to an existing raster collection.
 
 call ($name, $arguments, $expected_class=null)
 TODO: This function needs simplifying.
 
 listRasterCollectionsRasters ($id, $optParams=array())
 Return all rasters within a raster collection.
 

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

◆ batchDelete()

Google_Service_MapsEngine_RasterCollectionsRasters_Resource::batchDelete ( $id,
Google_Service_MapsEngine_RasterCollectionsRasterBatchDeleteRequest $postBody,
$optParams = array() )

Remove rasters from an existing raster collection.

Up to 50 rasters can be included in a single batchDelete request. Each batchDelete request is atomic. (rasters.batchDelete)

Parameters
string$idThe ID of the raster collection to which these rasters belong.
Google_RasterCollectionsRasterBatchDeleteRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_MapsEngine_RasterCollectionsRastersBatchDeleteResponse

◆ batchInsert()

Google_Service_MapsEngine_RasterCollectionsRasters_Resource::batchInsert ( $id,
Google_Service_MapsEngine_RasterCollectionsRastersBatchInsertRequest $postBody,
$optParams = array() )

Add rasters to an existing raster collection.

Rasters must be successfully processed in order to be added to a raster collection.

Up to 50 rasters can be included in a single batchInsert request. Each batchInsert request is atomic. (rasters.batchInsert)

Parameters
string$idThe ID of the raster collection to which these rasters belong.
Google_RasterCollectionsRastersBatchInsertRequest$postBody
array$optParamsOptional parameters.
Return values
Google_Service_MapsEngine_RasterCollectionsRastersBatchInsertResponse

◆ 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

◆ listRasterCollectionsRasters()

Google_Service_MapsEngine_RasterCollectionsRasters_Resource::listRasterCollectionsRasters ( $id,
$optParams = array() )

Return all rasters within a raster collection.

(rasters.listRasterCollectionsRasters)

Parameters
string$idThe ID of the raster collection to which these rasters belong.
array$optParamsOptional 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 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_RasterCollectionsRastersListResponse

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