Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / mapsengine_v1.rasterCollections.html
blob: a87d758b2ddc7c87c6291b8a9d79cdfb565d49c0 [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">
88 <code><a href="#create">create(body)</a></code></p>
89<p class="firstline">Create a raster collection asset.</p>
90<p class="toc_element">
91 <code><a href="#get">get(id)</a></code></p>
92<p class="firstline">Return metadata for a particular raster collection.</p>
93<p class="toc_element">
94 <code><a href="#list">list(modifiedAfter=None, createdAfter=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
95<p class="firstline">Return all raster collections readable by the current user.</p>
96<p class="toc_element">
97 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
98<p class="firstline">Retrieves the next page of results.</p>
99<h3>Method Details</h3>
100<div class="method">
101 <code class="details" id="create">create(body)</code>
102 <pre>Create a raster collection asset.
103
104Args:
105 body: object, The request body. (required)
106 The object takes the form of:
107
108{ # A raster collection groups multiple Raster resources for inclusion in a Layer.
109 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
110 "description": "A String", # The description of this RasterCollection, supplied by the author.
111 "tags": [ # Tags of this RasterCollection.
112 "A String",
113 ],
114 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
115 "projectId": "A String", # The ID of the project that this RasterCollection is in.
116 "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).
117 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
118 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitudes and longitudes in decimal degrees.
119 3.14,
120 ],
121 "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).
122 "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
123 "mosaic": True or False, # True if this RasterCollection is a mosaic.
124 "name": "A String", # The name of this RasterCollection, supplied by the author.
125 }
126
127
128Returns:
129 An object of the form:
130
131 { # A raster collection groups multiple Raster resources for inclusion in a Layer.
132 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
133 "description": "A String", # The description of this RasterCollection, supplied by the author.
134 "tags": [ # Tags of this RasterCollection.
135 "A String",
136 ],
137 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
138 "projectId": "A String", # The ID of the project that this RasterCollection is in.
139 "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).
140 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
141 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitudes and longitudes in decimal degrees.
142 3.14,
143 ],
144 "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).
145 "id": "A String", # A globally unique ID, used to refer to this RasterCollection.
146 "mosaic": True or False, # True if this RasterCollection is a mosaic.
147 "name": "A String", # The name of this RasterCollection, supplied by the author.
148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="get">get(id)</code>
153 <pre>Return metadata for a particular raster collection.
154
155Args:
156 id: string, The ID of the raster collection. (required)
157
158Returns:
159 An object of the form:
160
161 { # A raster collection groups multiple Raster resources for inclusion in a Layer.
162 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
163 "description": "A String", # The description of this RasterCollection, supplied by the author.
164 "tags": [ # Tags of this RasterCollection.
165 "A String",
166 ],
167 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
168 "projectId": "A String", # The ID of the project that this RasterCollection is in.
169 "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).
170 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
171 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitudes and longitudes 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="list">list(modifiedAfter=None, createdAfter=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
183 <pre>Return all raster collections readable by the current user.
184
185Args:
186 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.
187 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.
188 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.
189 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.
190 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
191 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.
192 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
193 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
194 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.
195
196Returns:
197 An object of the form:
198
199 { # The response returned by a call to raster_collections.List.
200 "nextPageToken": "A String", # Next page token.
201 "rasterCollections": [ # Resources returned.
202 { # A raster collection groups multiple Raster resources for inclusion in a Layer.
203 "attribution": "A String", # The name of the attribution to be used for this RasterCollection.
204 "description": "A String", # The description of this RasterCollection, supplied by the author.
205 "tags": [ # Tags of this RasterCollection.
206 "A String",
207 ],
208 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
209 "projectId": "A String", # The ID of the project that this RasterCollection is in.
210 "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).
211 "rasterType": "A String", # The type of rasters contained within this RasterCollection.
212 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this RasterCollection. The numbers represent latitudes and longitudes 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 },
220 ],
221 }</pre>
222</div>
223
224<div class="method">
225 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
226 <pre>Retrieves the next page of results.
227
228Args:
229 previous_request: The request for the previous page. (required)
230 previous_response: The response from the request for the previous page. (required)
231
232Returns:
233 A request object that you can call 'execute()' on to request the next
234 page. Returns None if there are no more items in the collection.
235 </pre>
236</div>
237
238</body></html>