Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b1cc515b93bef725389ac86401366b6f7a98b0c8 / . / docs / dyn / mapsengine_v1.rasters.html
blob: 006eab726eab579a9df18f272fb54a2d5952ed22 [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">
88 <code><a href="#get">get(id)</a></code></p>
89<p class="firstline">Return metadata for a single raster.</p>
90<p class="toc_element">
91 <code><a href="#upload">upload(body)</a></code></p>
92<p class="firstline">Create a skeleton raster asset for upload.</p>
93<h3>Method Details</h3>
94<div class="method">
95 <code class="details" id="get">get(id)</code>
96 <pre>Return metadata for a single raster.
97
98Args:
99 id: string, The ID of the raster. (required)
100
101Returns:
102 An object of the form:
103
104 { # A geo-referenced raster.
105 "files": [ # The files associated with this Raster.
106 { # A single File, which is a component of an Asset.
107 "size": "A String", # The size of the file in bytes.
108 "uploadStatus": "A String", # The upload status of the file.
109 "filename": "A String", # The name of the file.
110 },
111 ],
112 "attribution": "A String", # The name of the attribution to be used for this Raster.
113 "description": "A String", # The description of this Raster, supplied by the author.
114 "processingStatus": "A String", # The processing status of this Raster. The raster processing status values can be:
115 #
116 # 'notReady': The raster is not ready to be processed - some files have not been uploaded.
117 # 'ready': The raster is queued for processing.
118 # 'processing': The raster is currently processing.
119 # 'complete': Processing has completed successfully.
120 # 'failed': Processing failed to complete.
121 "draftAccessList": "A String", # The Map Editors access list to share this Raster with.
122 "projectId": "A String", # The ID of the project that this Raster is in.
123 "tags": [ # Tags of this Raster.
124 "A String",
125 ],
126 "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).
127 "name": "A String", # The name of this Raster, supplied by the author.
128 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
129 "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).
130 "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).
131 "precision": "A String", # The precision of acquisition time. Valid values include: 'year', 'month', 'day', 'hour', 'minute' and 'second'.
132 },
133 "maskType": "autoMask", # The mask processing type of this Raster. Valid values include "autoMask", "alphaChannelMask", "noMask", "imageMask".
134 "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).
135 "id": "A String", # A globally unique ID, used to refer to this Raster.
136 "rasterType": "image", # The type of this Raster. Always "image" today.
137 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Raster. The numbers represent latitudes and longitudes in decimal degrees.
138 3.14,
139 ],
140 }</pre>
141</div>
142
143<div class="method">
144 <code class="details" id="upload">upload(body)</code>
145 <pre>Create a skeleton raster asset for upload.
146
147Args:
148 body: object, The request body. (required)
149 The object takes the form of:
150
151{ # A geo-referenced raster.
152 "files": [ # The files associated with this Raster.
153 { # A single File, which is a component of an Asset.
154 "size": "A String", # The size of the file in bytes.
155 "uploadStatus": "A String", # The upload status of the file.
156 "filename": "A String", # The name of the file.
157 },
158 ],
159 "attribution": "A String", # The name of the attribution to be used for this Raster.
160 "description": "A String", # The description of this Raster, supplied by the author.
161 "processingStatus": "A String", # The processing status of this Raster. The raster processing status values can be:
162 #
163 # 'notReady': The raster is not ready to be processed - some files have not been uploaded.
164 # 'ready': The raster is queued for processing.
165 # 'processing': The raster is currently processing.
166 # 'complete': Processing has completed successfully.
167 # 'failed': Processing failed to complete.
168 "draftAccessList": "A String", # The Map Editors access list to share this Raster with.
169 "projectId": "A String", # The ID of the project that this Raster is in.
170 "tags": [ # Tags of this Raster.
171 "A String",
172 ],
173 "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).
174 "name": "A String", # The name of this Raster, supplied by the author.
175 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
176 "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).
177 "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).
178 "precision": "A String", # The precision of acquisition time. Valid values include: 'year', 'month', 'day', 'hour', 'minute' and 'second'.
179 },
180 "maskType": "autoMask", # The mask processing type of this Raster. Valid values include "autoMask", "alphaChannelMask", "noMask", "imageMask".
181 "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).
182 "id": "A String", # A globally unique ID, used to refer to this Raster.
183 "rasterType": "image", # The type of this Raster. Always "image" today.
184 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Raster. The numbers represent latitudes and longitudes in decimal degrees.
185 3.14,
186 ],
187 }
188
189
190Returns:
191 An object of the form:
192
193 { # A geo-referenced raster.
194 "files": [ # The files associated with this Raster.
195 { # A single File, which is a component of an Asset.
196 "size": "A String", # The size of the file in bytes.
197 "uploadStatus": "A String", # The upload status of the file.
198 "filename": "A String", # The name of the file.
199 },
200 ],
201 "attribution": "A String", # The name of the attribution to be used for this Raster.
202 "description": "A String", # The description of this Raster, supplied by the author.
203 "processingStatus": "A String", # The processing status of this Raster. The raster processing status values can be:
204 #
205 # 'notReady': The raster is not ready to be processed - some files have not been uploaded.
206 # 'ready': The raster is queued for processing.
207 # 'processing': The raster is currently processing.
208 # 'complete': Processing has completed successfully.
209 # 'failed': Processing failed to complete.
210 "draftAccessList": "A String", # The Map Editors access list to share this Raster with.
211 "projectId": "A String", # The ID of the project that this Raster is in.
212 "tags": [ # Tags of this Raster.
213 "A String",
214 ],
215 "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).
216 "name": "A String", # The name of this Raster, supplied by the author.
217 "acquisitionTime": { # Acquisition time represents acquired time of a raster. # The acquisition time of this Raster.
218 "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).
219 "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).
220 "precision": "A String", # The precision of acquisition time. Valid values include: 'year', 'month', 'day', 'hour', 'minute' and 'second'.
221 },
222 "maskType": "autoMask", # The mask processing type of this Raster. Valid values include "autoMask", "alphaChannelMask", "noMask", "imageMask".
223 "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).
224 "id": "A String", # A globally unique ID, used to refer to this Raster.
225 "rasterType": "image", # The type of this Raster. Always "image" today.
226 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Raster. The numbers represent latitudes and longitudes in decimal degrees.
227 3.14,
228 ],
229 }</pre>
230</div>
231
232</body></html>