Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / mapsengine_v1.rasterCollections.html
blob: 2b43d7405cb5b4928e83651baea50dcd8ee54ad7 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<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.rasterCollections.html">rasterCollections</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="mapsengine_v1.rasterCollections.parents.html">parents()</a></code>
79</p>
80<p class="firstline">Returns the parents Resource.</p>
81
82<p class="toc_element">
83 <code><a href="mapsengine_v1.rasterCollections.rasters.html">rasters()</a></code>
84</p>
85<p class="firstline">Returns the rasters Resource.</p>
86
87<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]88 <code><a href="#cancelProcessing">cancelProcessing(id)</a></code></p>
89<p class="firstline">Cancel processing on a raster collection asset.</p>
90<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91 <code><a href="#create">create(body)</a></code></p>
92<p class="firstline">Create a raster collection asset.</p>
93<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]94 <code><a href="#delete">delete(id)</a></code></p>
95<p class="firstline">Delete a raster collection.</p>
96<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]97 <code><a href="#get">get(id)</a></code></p>
98<p class="firstline">Return metadata for a particular raster collection.</p>
99<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]100 <code><a href="#list">list(modifiedAfter=None, createdAfter=None, tags=None, projectId=None, maxResults=None, pageToken=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101<p class="firstline">Return all raster collections readable by the current user.</p>
102<p class="toc_element">
103 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
104<p class="firstline">Retrieves the next page of results.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]105<p class="toc_element">
106 <code><a href="#patch">patch(id, body)</a></code></p>
107<p class="firstline">Mutate a raster collection asset.</p>
108<p class="toc_element">
109 <code><a href="#process">process(id)</a></code></p>
110<p class="firstline">Process a raster collection asset.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]111<h3>Method Details</h3>
112<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]113 <code class="details" id="cancelProcessing">cancelProcessing(id)</code>
114 <pre>Cancel processing on a raster collection asset.
115
116Args:
117 id: string, The ID of the raster collection. (required)
118
119Returns:
120 An object of the form:
121
122 { # The response returned by a call to any asset's Process method.
123 }</pre>
124</div>
125
126<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]127 <code class="details" id="create">create(body)</code>
128 <pre>Create a raster collection asset.
129
130Args:
131 body: object, The request body. (required)
132 The object takes the form of:
133
134{ # A raster collection groups multiple Raster resources for inclusion in a Layer.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]135 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
136 "description": "A String", # The description of this RasterCollection, supplied by the author.
137 "processingStatus": "A String", # The processing status of this RasterCollection.
138 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
139 "projectId": "A String", # The ID of the project that this RasterCollection is in.
140 "tags": [ # Tags of this RasterCollection.
141 "A String",
142 ],
143 "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
144 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
145 "etag": "A String", # The ETag, used to refer to the current version of the asset.
146 "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitude and longitude in decimal degrees.
147 3.14,
148 ],
149 "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
150 "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
151 "mosaic": True or False, # True if this RasterCollection is a mosaic.
152 "name": "A String", # The name of this RasterCollection, supplied by the author.
153}
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154
155
156Returns:
157 An object of the form:
158
159 { # A raster collection groups multiple Raster resources for inclusion in a Layer.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]160 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
161 "description": "A String", # The description of this RasterCollection, supplied by the author.
162 "processingStatus": "A String", # The processing status of this RasterCollection.
163 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
164 "projectId": "A String", # The ID of the project that this RasterCollection is in.
165 "tags": [ # Tags of this RasterCollection.
166 "A String",
167 ],
168 "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
169 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
170 "etag": "A String", # The ETag, used to refer to the current version of the asset.
171 "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitude and longitude in decimal degrees.
172 3.14,
173 ],
174 "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
175 "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
176 "mosaic": True or False, # True if this RasterCollection is a mosaic.
177 "name": "A String", # The name of this RasterCollection, supplied by the author.
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="delete">delete(id)</code>
183 <pre>Delete a raster collection.
184
185Args:
186 id: string, The ID of the raster collection. Only the raster collection creator or project owner are permitted to delete. If the rastor collection is included in a layer, the request will fail. Remove the raster collection from all layers prior to deleting. (required)
187</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188</div>
189
190<div class="method">
191 <code class="details" id="get">get(id)</code>
192 <pre>Return metadata for a particular raster collection.
193
194Args:
195 id: string, The ID of the raster collection. (required)
196
197Returns:
198 An object of the form:
199
200 { # A raster collection groups multiple Raster resources for inclusion in a Layer.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]201 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
202 "description": "A String", # The description of this RasterCollection, supplied by the author.
203 "processingStatus": "A String", # The processing status of this RasterCollection.
204 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
205 "projectId": "A String", # The ID of the project that this RasterCollection is in.
206 "tags": [ # Tags of this RasterCollection.
207 "A String",
208 ],
209 "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
210 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
211 "etag": "A String", # The ETag, used to refer to the current version of the asset.
212 "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitude and longitude in decimal degrees.
213 3.14,
214 ],
215 "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
216 "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
217 "mosaic": True or False, # True if this RasterCollection is a mosaic.
218 "name": "A String", # The name of this RasterCollection, supplied by the author.
219 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220</div>
221
222<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]223 <code class="details" id="list">list(modifiedAfter=None, createdAfter=None, tags=None, projectId=None, maxResults=None, pageToken=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]224 <pre>Return all raster collections readable by the current user.
225
226Args:
227 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.
228 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]229 tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]230 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.
231 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]232 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]233 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.
234 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
235 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
236 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.
237
238Returns:
239 An object of the form:
240
241 { # The response returned by a call to raster_collections.List.
242 "nextPageToken": "A String", # Next page token.
243 "rasterCollections": [ # Resources returned.
244 { # A raster collection groups multiple Raster resources for inclusion in a Layer.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]245 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
246 "description": "A String", # The description of this RasterCollection, supplied by the author.
247 "processingStatus": "A String", # The processing status of this RasterCollection.
248 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
249 "projectId": "A String", # The ID of the project that this RasterCollection is in.
250 "tags": [ # Tags of this RasterCollection.
251 "A String",
252 ],
253 "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
254 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
255 "etag": "A String", # The ETag, used to refer to the current version of the asset.
256 "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitude and longitude in decimal degrees.
257 3.14,
258 ],
259 "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
260 "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
261 "mosaic": True or False, # True if this RasterCollection is a mosaic.
262 "name": "A String", # The name of this RasterCollection, supplied by the author.
263 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]264 ],
265 }</pre>
266</div>
267
268<div class="method">
269 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
270 <pre>Retrieves the next page of results.
271
272Args:
273 previous_request: The request for the previous page. (required)
274 previous_response: The response from the request for the previous page. (required)
275
276Returns:
277 A request object that you can call 'execute()' on to request the next
278 page. Returns None if there are no more items in the collection.
279 </pre>
280</div>
281
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]282<div class="method">
283 <code class="details" id="patch">patch(id, body)</code>
284 <pre>Mutate a raster collection asset.
285
286Args:
287 id: string, The ID of the raster collection. (required)
288 body: object, The request body. (required)
289 The object takes the form of:
290
291{ # A raster collection groups multiple Raster resources for inclusion in a Layer.
292 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
293 "description": "A String", # The description of this RasterCollection, supplied by the author.
294 "processingStatus": "A String", # The processing status of this RasterCollection.
295 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
296 "projectId": "A String", # The ID of the project that this RasterCollection is in.
297 "tags": [ # Tags of this RasterCollection.
298 "A String",
299 ],
300 "creationTime": "A String", # The creation time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
301 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
302 "etag": "A String", # The ETag, used to refer to the current version of the asset.
303 "bbox": [ # A rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitude and longitude in decimal degrees.
304 3.14,
305 ],
306 "lastModifiedTime": "A String", # The last modified time of this RasterCollection. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
307 "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
308 "mosaic": True or False, # True if this RasterCollection is a mosaic.
309 "name": "A String", # The name of this RasterCollection, supplied by the author.
310}
311
312</pre>
313</div>
314
315<div class="method">
316 <code class="details" id="process">process(id)</code>
317 <pre>Process a raster collection asset.
318
319Args:
320 id: string, The ID of the raster collection. (required)
321
322Returns:
323 An object of the form:
324
325 { # The response returned by a call to any asset's Process method.
326 }</pre>
327</div>
328
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329</body></html>