blob: 8c7a2f60be411d2fa9caac0f0979515829f5bde5 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.rasters.html">rasters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="mapsengine_v1.rasters.files.html">files()</a></code>
79</p>
80<p class="firstline">Returns the files Resource.</p>
81
82<p class="toc_element">
83 <code><a href="mapsengine_v1.rasters.parents.html">parents()</a></code>
84</p>
85<p class="firstline">Returns the parents Resource.</p>
86
87<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -070088 <code><a href="mapsengine_v1.rasters.permissions.html">permissions()</a></code>
89</p>
90<p class="firstline">Returns the permissions Resource.</p>
91
92<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -070093 <code><a href="#delete">delete(id)</a></code></p>
94<p class="firstline">Delete a raster.</p>
95<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040096 <code><a href="#get">get(id)</a></code></p>
97<p class="firstline">Return metadata for a single raster.</p>
98<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -070099 <code><a href="#list">list(projectId, modifiedBefore=None, creatorEmail=None, processingStatus=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
100<p class="firstline">Return all rasters readable by the current user.</p>
101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700105 <code><a href="#patch">patch(id, body)</a></code></p>
106<p class="firstline">Mutate a raster asset.</p>
107<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700108 <code><a href="#process">process(id)</a></code></p>
109<p class="firstline">Process a raster asset.</p>
110<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400111 <code><a href="#upload">upload(body)</a></code></p>
112<p class="firstline">Create a skeleton raster asset for upload.</p>
113<h3>Method Details</h3>
114<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700115 <code class="details" id="delete">delete(id)</code>
116 <pre>Delete a raster.
117
118Args:
119 id: string, 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. (required)
120</pre>
121</div>
122
123<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400124 <code class="details" id="get">get(id)</code>
125 <pre>Return metadata for a single raster.
126
127Args:
128 id: string, The ID of the raster. (required)
129
130Returns:
131 An object of the form:
132
133 { # A geo-referenced raster.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700134 "files": [ # The files associated with this Raster.
135 { # A single File, which is a component of an Asset.
136 "size": "A String", # The size of the file in bytes.
137 "uploadStatus": "A String", # The upload status of the file.
138 "filename": "A String", # The name of the file.
John Asmuth614db982014-04-24 15:46:26 -0400139 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700140 ],
141 "attribution": "A String", # The name of the attribution to be used for this Raster.
142 "description": "A String", # The description of this Raster, supplied by the author.
143 "processingStatus": "A String", # The processing status of this Raster.
144 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
145 "projectId": "A String", # The ID of the project that this Raster is in.
146 "tags": [ # Tags of this Raster.
147 "A String",
148 ],
149 "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
150 "name": "A String", # The name of this Raster, supplied by the author.
151 "maskType": "autoMask", # The mask processing type of this Raster.
152 "etag": "A String", # The ETag, used to refer to the current version of the asset.
153 "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
154 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
155 "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
156 "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
157 "precision": "A String", # The precision of acquisition time.
158 },
159 "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
160 "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
161 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
162 "id": "A String", # A globally unique ID, used to refer to this Raster.
163 "rasterType": "A String", # The type of this Raster. Always "image" today.
164 "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
165 3.14,
166 ],
167 }</pre>
168</div>
169
170<div class="method">
171 <code class="details" id="list">list(projectId, modifiedBefore=None, creatorEmail=None, processingStatus=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
172 <pre>Return all rasters readable by the current user.
173
174Args:
175 projectId: string, 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. (required)
176 modifiedBefore: string, 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.
177 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
178 processingStatus: string, A parameter
179 Allowed values
180 complete - The raster has completed processing.
181 failed - The raster has failed processing.
182 notReady - The raster is not ready for processing.
183 processing - The raster is processing.
184 ready - The raster is ready for processing.
185 pageToken: string, 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.
186 role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
187 Allowed values
188 owner - The user can read, write and administer the asset.
189 reader - The user can read the asset.
190 writer - The user can read and write the asset.
191 createdAfter: string, 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.
192 tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
193 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
194 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
195 modifiedAfter: string, 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.
196 search: string, An unstructured search string used to filter the set of results based on asset metadata.
197 createdBefore: string, 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.
198
199Returns:
200 An object of the form:
201
202 { # The response returned by a call to rasters.List.
203 "nextPageToken": "A String", # Next page token.
204 "rasters": [ # Resources returned.
205 { # A geo-referenced raster.
206 "files": [ # The files associated with this Raster.
207 { # A single File, which is a component of an Asset.
208 "size": "A String", # The size of the file in bytes.
209 "uploadStatus": "A String", # The upload status of the file.
210 "filename": "A String", # The name of the file.
211 },
212 ],
213 "attribution": "A String", # The name of the attribution to be used for this Raster.
214 "description": "A String", # The description of this Raster, supplied by the author.
215 "processingStatus": "A String", # The processing status of this Raster.
216 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
217 "projectId": "A String", # The ID of the project that this Raster is in.
218 "tags": [ # Tags of this Raster.
219 "A String",
220 ],
221 "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
222 "name": "A String", # The name of this Raster, supplied by the author.
223 "maskType": "autoMask", # The mask processing type of this Raster.
224 "etag": "A String", # The ETag, used to refer to the current version of the asset.
225 "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
226 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
227 "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
228 "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
229 "precision": "A String", # The precision of acquisition time.
230 },
231 "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
232 "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
233 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
234 "id": "A String", # A globally unique ID, used to refer to this Raster.
235 "rasterType": "A String", # The type of this Raster. Always "image" today.
236 "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
237 3.14,
238 ],
239 },
240 ],
241 }</pre>
242</div>
243
244<div class="method">
245 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
246 <pre>Retrieves the next page of results.
247
248Args:
249 previous_request: The request for the previous page. (required)
250 previous_response: The response from the request for the previous page. (required)
251
252Returns:
253 A request object that you can call 'execute()' on to request the next
254 page. Returns None if there are no more items in the collection.
255 </pre>
John Asmuth614db982014-04-24 15:46:26 -0400256</div>
257
258<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700259 <code class="details" id="patch">patch(id, body)</code>
260 <pre>Mutate a raster asset.
261
262Args:
263 id: string, The ID of the raster. (required)
264 body: object, The request body. (required)
265 The object takes the form of:
266
267{ # A geo-referenced raster.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700268 "files": [ # The files associated with this Raster.
269 { # A single File, which is a component of an Asset.
270 "size": "A String", # The size of the file in bytes.
271 "uploadStatus": "A String", # The upload status of the file.
272 "filename": "A String", # The name of the file.
Craig Citro065b5302014-08-14 00:47:23 -0700273 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700274 ],
275 "attribution": "A String", # The name of the attribution to be used for this Raster.
276 "description": "A String", # The description of this Raster, supplied by the author.
277 "processingStatus": "A String", # The processing status of this Raster.
278 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
279 "projectId": "A String", # The ID of the project that this Raster is in.
280 "tags": [ # Tags of this Raster.
281 "A String",
282 ],
283 "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
284 "name": "A String", # The name of this Raster, supplied by the author.
285 "maskType": "autoMask", # The mask processing type of this Raster.
286 "etag": "A String", # The ETag, used to refer to the current version of the asset.
287 "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
288 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
289 "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
290 "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
291 "precision": "A String", # The precision of acquisition time.
292 },
293 "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
294 "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
295 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
296 "id": "A String", # A globally unique ID, used to refer to this Raster.
297 "rasterType": "A String", # The type of this Raster. Always "image" today.
298 "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
299 3.14,
300 ],
301}
Craig Citro065b5302014-08-14 00:47:23 -0700302
303</pre>
304</div>
305
306<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700307 <code class="details" id="process">process(id)</code>
308 <pre>Process a raster asset.
309
310Args:
311 id: string, The ID of the raster. (required)
312
313Returns:
314 An object of the form:
315
316 { # The response returned by a call to any asset's Process method.
317 }</pre>
318</div>
319
320<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400321 <code class="details" id="upload">upload(body)</code>
322 <pre>Create a skeleton raster asset for upload.
323
324Args:
325 body: object, The request body. (required)
326 The object takes the form of:
327
328{ # A geo-referenced raster.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700329 "files": [ # The files associated with this Raster.
330 { # A single File, which is a component of an Asset.
331 "size": "A String", # The size of the file in bytes.
332 "uploadStatus": "A String", # The upload status of the file.
333 "filename": "A String", # The name of the file.
334 },
335 ],
336 "attribution": "A String", # The name of the attribution to be used for this Raster.
337 "description": "A String", # The description of this Raster, supplied by the author.
338 "processingStatus": "A String", # The processing status of this Raster.
339 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
340 "projectId": "A String", # The ID of the project that this Raster is in.
341 "tags": [ # Tags of this Raster.
342 "A String",
343 ],
344 "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
345 "name": "A String", # The name of this Raster, supplied by the author.
346 "maskType": "autoMask", # The mask processing type of this Raster.
347 "etag": "A String", # The ETag, used to refer to the current version of the asset.
348 "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
349 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
350 "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
351 "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
352 "precision": "A String", # The precision of acquisition time.
353 },
354 "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
355 "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
356 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
357 "id": "A String", # A globally unique ID, used to refer to this Raster.
358 "rasterType": "A String", # The type of this Raster. Always "image" today.
359 "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
360 3.14,
361 ],
362}
363
364
365Returns:
366 An object of the form:
367
368 { # A geo-referenced raster.
John Asmuth614db982014-04-24 15:46:26 -0400369 "files": [ # The files associated with this Raster.
370 { # A single File, which is a component of an Asset.
371 "size": "A String", # The size of the file in bytes.
372 "uploadStatus": "A String", # The upload status of the file.
373 "filename": "A String", # The name of the file.
374 },
375 ],
376 "attribution": "A String", # The name of the attribution to be used for this Raster.
377 "description": "A String", # The description of this Raster, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700378 "processingStatus": "A String", # The processing status of this Raster.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700379 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
John Asmuth614db982014-04-24 15:46:26 -0400380 "projectId": "A String", # The ID of the project that this Raster is in.
381 "tags": [ # Tags of this Raster.
382 "A String",
383 ],
384 "creationTime": "A String", # The creation time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
385 "name": "A String", # The name of this Raster, supplied by the author.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700386 "maskType": "autoMask", # The mask processing type of this Raster.
Craig Citro065b5302014-08-14 00:47:23 -0700387 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700388 "creatorEmail": "A String", # The email address of the creator of this raster. This is only returned on GET requests and not LIST requests.
John Asmuth614db982014-04-24 15:46:26 -0400389 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
390 "start": "A String", # The acquisition time, or start time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
391 "end": "A String", # The end time if acquisition time is a range. The value is an RFC 3339 formatted date-time value (1970-01-01T00:00:00Z).
Craig Citro065b5302014-08-14 00:47:23 -0700392 "precision": "A String", # The precision of acquisition time.
John Asmuth614db982014-04-24 15:46:26 -0400393 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700394 "lastModifierEmail": "A String", # The email address of the last modifier of this raster. This is only returned on GET requests and not LIST requests.
John Asmuth614db982014-04-24 15:46:26 -0400395 "lastModifiedTime": "A String", # The last modified time of this raster. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700396 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
John Asmuth614db982014-04-24 15:46:26 -0400397 "id": "A String", # A globally unique ID, used to refer to this Raster.
Craig Citro065b5302014-08-14 00:47:23 -0700398 "rasterType": "A String", # The type of this Raster. Always "image" today.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700399 "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The box is expressed as \"west, south, east, north\". The numbers represent latitudes and longitudes in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400400 3.14,
401 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700402 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400403</div>
404
405</body></html>