Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / mapsengine_v1.rasterCollections.rasters.html
blob: cbc4e701cfadb49cca5c3338acee0f12c262bf58 [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> . <a href="mapsengine_v1.rasterCollections.rasters.html">rasters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]78 <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
79<p class="firstline">Remove rasters from an existing raster collection.</p>
80<p class="toc_element">
81 <code><a href="#batchInsert">batchInsert(id, body)</a></code></p>
82<p class="firstline">Add rasters to an existing raster collection. Rasters must be successfully processed in order to be added to a raster collection.</p>
83<p class="toc_element">
84 <code><a href="#list">list(id, modifiedAfter=None, pageToken=None, createdAfter=None, tags=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]85<p class="firstline">Return all rasters within a raster collection.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]91 <code class="details" id="batchDelete">batchDelete(id, body)</code>
92 <pre>Remove rasters from an existing raster collection.
93
94Up to 50 rasters can be included in a single batchDelete request. Each batchDelete request is atomic.
95
96Args:
97 id: string, The ID of the raster collection to which these rasters belong. (required)
98 body: object, The request body. (required)
99 The object takes the form of:
100
101{ # The request sent to rasterCollections.Rasters.BatchDelete.
102 "ids": [ # An array of Raster asset IDs to be removed from this RasterCollection.
103 "A String",
104 ],
105 }
106
107
108Returns:
109 An object of the form:
110
111 { # The response returned by a call to rasterCollections.rasters.batchDelete.
112 }</pre>
113</div>
114
115<div class="method">
116 <code class="details" id="batchInsert">batchInsert(id, body)</code>
117 <pre>Add rasters to an existing raster collection. Rasters must be successfully processed in order to be added to a raster collection.
118
119Up to 50 rasters can be included in a single batchInsert request. Each batchInsert request is atomic.
120
121Args:
122 id: string, The ID of the raster collection to which these rasters belong. (required)
123 body: object, The request body. (required)
124 The object takes the form of:
125
126{ # The request sent to rasterCollections.Rasters.BatchInsert.
127 "ids": [ # An array of Raster asset IDs to be added to this RasterCollection.
128 "A String",
129 ],
130 }
131
132
133Returns:
134 An object of the form:
135
136 { # The response returned by a call to rasterCollections.rasters.batchInsert.
137 }</pre>
138</div>
139
140<div class="method">
141 <code class="details" id="list">list(id, modifiedAfter=None, pageToken=None, createdAfter=None, tags=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 <pre>Return all rasters within a raster collection.
143
144Args:
145 id: string, The ID of the raster collection to which these rasters belong. (required)
146 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]147 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]148 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.
149 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]150 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
151 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.
152 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
153 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
154 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.
155
156Returns:
157 An object of the form:
158
159 { # The response returned by a call to rasterCollections.rasters.List.
160 "nextPageToken": "A String", # Next page token.
161 "rasters": [ # Resources returned.
162 { # A raster resource.
163 "name": "A String", # The name of this Raster, supplied by the author.
164 "tags": [ # Tags of this Raster.
165 "A String",
166 ],
167 "rasterType": "image", # The type of this Raster. Always "image" today.
168 "projectId": "A String", # The ID of the project that this Raster is in.
169 "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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]170 "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 3.14,
172 ],
173 "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).
174 "id": "A String", # A globally unique ID, used to refer to this Raster.
175 "description": "A String", # The description of this Raster, supplied by the author.
176 },
177 ],
178 }</pre>
179</div>
180
181<div class="method">
182 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
183 <pre>Retrieves the next page of results.
184
185Args:
186 previous_request: The request for the previous page. (required)
187 previous_response: The response from the request for the previous page. (required)
188
189Returns:
190 A request object that you can call 'execute()' on to request the next
191 page. Returns None if there are no more items in the collection.
192 </pre>
193</div>
194
195</body></html>