Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / mapsengine_v1.rasters.html
blob: a24f148d25beee5b66babbf9a69b0d671b128d9a [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.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 Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]88 <code><a href="#delete">delete(id)</a></code></p>
89<p class="firstline">Delete a raster.</p>
90<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]91 <code><a href="#get">get(id)</a></code></p>
92<p class="firstline">Return metadata for a single raster.</p>
93<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]94 <code><a href="#patch">patch(id, body)</a></code></p>
95<p class="firstline">Mutate a raster asset.</p>
96<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]97 <code><a href="#upload">upload(body)</a></code></p>
98<p class="firstline">Create a skeleton raster asset for upload.</p>
99<h3>Method Details</h3>
100<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101 <code class="details" id="delete">delete(id)</code>
102 <pre>Delete a raster.
103
104Args:
105 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)
106</pre>
107</div>
108
109<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]110 <code class="details" id="get">get(id)</code>
111 <pre>Return metadata for a single raster.
112
113Args:
114 id: string, The ID of the raster. (required)
115
116Returns:
117 An object of the form:
118
119 { # A geo-referenced raster.
120 "files": [ # The files associated with this Raster.
121 { # A single File, which is a component of an Asset.
122 "size": "A String", # The size of the file in bytes.
123 "uploadStatus": "A String", # The upload status of the file.
124 "filename": "A String", # The name of the file.
125 },
126 ],
127 "attribution": "A String", # The name of the attribution to be used for this Raster.
128 "description": "A String", # The description of this Raster, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]129 "processingStatus": "A String", # The processing status of this Raster.
130 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 "projectId": "A String", # The ID of the project that this Raster is in.
132 "tags": [ # Tags of this Raster.
133 "A String",
134 ],
135 "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).
136 "name": "A String", # The name of this Raster, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]137 "etag": "A String", # The ETag, used to refer to the current version of the asset.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
139 "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).
140 "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 -0700[diff] [blame]141 "precision": "A String", # The precision of acquisition time.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]142 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]143 "maskType": "autoMask", # The mask processing type of this Raster.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 "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).
145 "id": "A String", # A globally unique ID, used to refer to this Raster.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]146 "rasterType": "A String", # The type of this Raster. Always "image" today.
147 "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]148 3.14,
149 ],
150 }</pre>
151</div>
152
153<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]154 <code class="details" id="patch">patch(id, body)</code>
155 <pre>Mutate a raster asset.
156
157Args:
158 id: string, The ID of the raster. (required)
159 body: object, The request body. (required)
160 The object takes the form of:
161
162{ # A geo-referenced raster.
163 "files": [ # The files associated with this Raster.
164 { # A single File, which is a component of an Asset.
165 "size": "A String", # The size of the file in bytes.
166 "uploadStatus": "A String", # The upload status of the file.
167 "filename": "A String", # The name of the file.
168 },
169 ],
170 "attribution": "A String", # The name of the attribution to be used for this Raster.
171 "description": "A String", # The description of this Raster, supplied by the author.
172 "processingStatus": "A String", # The processing status of this Raster.
173 "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.
174 "projectId": "A String", # The ID of the project that this Raster is in.
175 "tags": [ # Tags of this Raster.
176 "A String",
177 ],
178 "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).
179 "name": "A String", # The name of this Raster, supplied by the author.
180 "etag": "A String", # The ETag, used to refer to the current version of the asset.
181 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
182 "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).
183 "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).
184 "precision": "A String", # The precision of acquisition time.
185 },
186 "maskType": "autoMask", # The mask processing type of this Raster.
187 "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).
188 "id": "A String", # A globally unique ID, used to refer to this Raster.
189 "rasterType": "A String", # The type of this Raster. Always "image" today.
190 "bbox": [ # A rectangular bounding box which contains all of the data in this Raster. The numbers represent latitude and longitude in decimal degrees.
191 3.14,
192 ],
193 }
194
195</pre>
196</div>
197
198<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]199 <code class="details" id="upload">upload(body)</code>
200 <pre>Create a skeleton raster asset for upload.
201
202Args:
203 body: object, The request body. (required)
204 The object takes the form of:
205
206{ # A geo-referenced raster.
207 "files": [ # The files associated with this Raster.
208 { # A single File, which is a component of an Asset.
209 "size": "A String", # The size of the file in bytes.
210 "uploadStatus": "A String", # The upload status of the file.
211 "filename": "A String", # The name of the file.
212 },
213 ],
214 "attribution": "A String", # The name of the attribution to be used for this Raster.
215 "description": "A String", # The description of this Raster, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]216 "processingStatus": "A String", # The processing status of this Raster.
217 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218 "projectId": "A String", # The ID of the project that this Raster is in.
219 "tags": [ # Tags of this Raster.
220 "A String",
221 ],
222 "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).
223 "name": "A String", # The name of this Raster, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]224 "etag": "A String", # The ETag, used to refer to the current version of the asset.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]225 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
226 "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).
227 "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 -0700[diff] [blame]228 "precision": "A String", # The precision of acquisition time.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]229 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]230 "maskType": "autoMask", # The mask processing type of this Raster.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 "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).
232 "id": "A String", # A globally unique ID, used to refer to this Raster.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]233 "rasterType": "A String", # The type of this Raster. Always "image" today.
234 "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]235 3.14,
236 ],
237 }
238
239
240Returns:
241 An object of the form:
242
243 { # A geo-referenced raster.
244 "files": [ # The files associated with this Raster.
245 { # A single File, which is a component of an Asset.
246 "size": "A String", # The size of the file in bytes.
247 "uploadStatus": "A String", # The upload status of the file.
248 "filename": "A String", # The name of the file.
249 },
250 ],
251 "attribution": "A String", # The name of the attribution to be used for this Raster.
252 "description": "A String", # The description of this Raster, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]253 "processingStatus": "A String", # The processing status of this Raster.
254 "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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]255 "projectId": "A String", # The ID of the project that this Raster is in.
256 "tags": [ # Tags of this Raster.
257 "A String",
258 ],
259 "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).
260 "name": "A String", # The name of this Raster, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]261 "etag": "A String", # The ETag, used to refer to the current version of the asset.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
263 "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).
264 "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 -0700[diff] [blame]265 "precision": "A String", # The precision of acquisition time.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]266 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]267 "maskType": "autoMask", # The mask processing type of this Raster.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]268 "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).
269 "id": "A String", # A globally unique ID, used to refer to this Raster.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]270 "rasterType": "A String", # The type of this Raster. Always "image" today.
271 "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]272 3.14,
273 ],
274 }</pre>
275</div>
276
277</body></html>