GoogleGAL_Service_MapsEngine_Rasters_Resource

The "rasters" collection of methods.

Defined (1)

The class is defined in the following location(s).

/core/Google/Service/MapsEngine.php  
  1. class GoogleGAL_Service_MapsEngine_Rasters_Resource extends GoogleGAL_Service_Resource 
  2.  
  3. /** 
  4. * Delete a raster. (rasters.delete) 
  5. * @param string $id The ID of the raster. Only the raster creator or project 
  6. * owner are permitted to delete. If the raster is included in a layer or 
  7. * mosaic, the request will fail. Remove it from all parents prior to deleting. 
  8. * @param array $optParams Optional parameters. 
  9. */ 
  10. public function delete($id, $optParams = array()) 
  11. $params = array('id' => $id); 
  12. $params = array_merge($params, $optParams); 
  13. return $this->call('delete', array($params)); 
  14.  
  15. /** 
  16. * Return metadata for a single raster. (rasters.get) 
  17. * @param string $id The ID of the raster. 
  18. * @param array $optParams Optional parameters. 
  19. * @return GoogleGAL_Service_MapsEngine_Raster 
  20. */ 
  21. public function get($id, $optParams = array()) 
  22. $params = array('id' => $id); 
  23. $params = array_merge($params, $optParams); 
  24. return $this->call('get', array($params), "GoogleGAL_Service_MapsEngine_Raster"); 
  25.  
  26. /** 
  27. * Return all rasters readable by the current user. (rasters.listRasters) 
  28. * @param string $projectId The ID of a Maps Engine project, used to filter the 
  29. * response. To list all available projects with their IDs, send a Projects: 
  30. * list request. You can also find your project ID as the value of the 
  31. * DashboardPlace:cid URL parameter when signed in to mapsengine.google.com. 
  32. * @param array $optParams Optional parameters. 
  33. * @opt_param string modifiedAfter An RFC 3339 formatted date-time value (e.g. 
  34. * 1970-01-01T00:00:00Z). Returned assets will have been modified at or after 
  35. * this time. 
  36. * @opt_param string createdAfter An RFC 3339 formatted date-time value (e.g. 
  37. * 1970-01-01T00:00:00Z). Returned assets will have been created at or after 
  38. * this time. 
  39. * @opt_param string processingStatus 
  40. * @opt_param string tags A comma separated list of tags. Returned assets will 
  41. * contain all the tags from the list. 
  42. * @opt_param string search An unstructured search string used to filter the set 
  43. * of results based on asset metadata. 
  44. * @opt_param string maxResults The maximum number of items to include in a 
  45. * single response page. The maximum supported value is 100. 
  46. * @opt_param string pageToken The continuation token, used to page through 
  47. * large result sets. To get the next page of results, set this parameter to the 
  48. * value of nextPageToken from the previous response. 
  49. * @opt_param string creatorEmail An email address representing a user. Returned 
  50. * assets that have been created by the user associated with the provided email 
  51. * address. 
  52. * @opt_param string bbox A bounding box, expressed as "west, south, east, north". 
  53. * If set, only assets which intersect this bounding box will be returned. 
  54. * @opt_param string modifiedBefore An RFC 3339 formatted date-time value (e.g. 
  55. * 1970-01-01T00:00:00Z). Returned assets will have been modified at or before 
  56. * this time. 
  57. * @opt_param string createdBefore An RFC 3339 formatted date-time value (e.g. 
  58. * 1970-01-01T00:00:00Z). Returned assets will have been created at or before 
  59. * this time. 
  60. * @opt_param string role The role parameter indicates that the response should 
  61. * only contain assets where the current user has the specified level of access. 
  62. * @return GoogleGAL_Service_MapsEngine_RastersListResponse 
  63. */ 
  64. public function listRasters($projectId, $optParams = array()) 
  65. $params = array('projectId' => $projectId); 
  66. $params = array_merge($params, $optParams); 
  67. return $this->call('list', array($params), "GoogleGAL_Service_MapsEngine_RastersListResponse"); 
  68.  
  69. /** 
  70. * Mutate a raster asset. (rasters.patch) 
  71. * @param string $id The ID of the raster. 
  72. * @param GoogleGAL_Raster $postBody 
  73. * @param array $optParams Optional parameters. 
  74. */ 
  75. public function patch($id, GoogleGAL_Service_MapsEngine_Raster $postBody, $optParams = array()) 
  76. $params = array('id' => $id, 'postBody' => $postBody); 
  77. $params = array_merge($params, $optParams); 
  78. return $this->call('patch', array($params)); 
  79.  
  80. /** 
  81. * Process a raster asset. (rasters.process) 
  82. * @param string $id The ID of the raster. 
  83. * @param array $optParams Optional parameters. 
  84. * @return GoogleGAL_Service_MapsEngine_ProcessResponse 
  85. */ 
  86. public function process($id, $optParams = array()) 
  87. $params = array('id' => $id); 
  88. $params = array_merge($params, $optParams); 
  89. return $this->call('process', array($params), "GoogleGAL_Service_MapsEngine_ProcessResponse"); 
  90.  
  91. /** 
  92. * Create a skeleton raster asset for upload. (rasters.upload) 
  93. * @param GoogleGAL_Raster $postBody 
  94. * @param array $optParams Optional parameters. 
  95. * @return GoogleGAL_Service_MapsEngine_Raster 
  96. */ 
  97. public function upload(GoogleGAL_Service_MapsEngine_Raster $postBody, $optParams = array()) 
  98. $params = array('postBody' => $postBody); 
  99. $params = array_merge($params, $optParams); 
  100. return $this->call('upload', array($params), "GoogleGAL_Service_MapsEngine_Raster");