Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c29aaa9f8e5155f7a948c149fd2fec14e93f588c / . / docs / dyn / fusiontables_v1.table.html
blob: 6bfdddce001d162641e7ce20585b6ad412d17ca6 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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="fusiontables_v1.html">Fusion Tables API</a> . <a href="fusiontables_v1.table.html">table</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(tableId)</a></code></p>
79<p class="firstline">Deletes a table.</p>
80<p class="toc_element">
81 <code><a href="#get">get(tableId)</a></code></p>
82<p class="firstline">Retrieves a specific table by its id.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(body)</a></code></p>
85<p class="firstline">Creates a new table.</p>
86<p class="toc_element">
87 <code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Retrieves a list of tables a user owns.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(tableId, body, replaceViewDefinition=None)</a></code></p>
94<p class="firstline">Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(tableId, body, replaceViewDefinition=None)</a></code></p>
97<p class="firstline">Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(tableId)</code>
101 <pre>Deletes a table.
102
103Args:
104 tableId: string, Id of the table that is being deleted. (required)
105</pre>
106</div>
107
108<div class="method">
109 <code class="details" id="get">get(tableId)</code>
110 <pre>Retrieves a specific table by its id.
111
112Args:
113 tableId: string, Identifier(ID) for the table being requested. (required)
114
115Returns:
116 An object of the form:
117
118 { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
119 "kind": "fusiontables#table", # Type name: a template for an individual table.
120 "attribution": "A String", # Optional attribution assigned to the table.
121 "description": "A String", # Optional description assigned to the table.
122 "isExportable": True or False, # Variable for whether table is exportable.
123 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
124 "A String",
125 ],
126 "attributionLink": "A String", # Optional link for attribution.
127 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
128 "columns": [ # Columns in the table.
129 { # Specifies the id, name and type of a column in a table.
130 "kind": "fusiontables#column", # Type name: a template for an individual column.
131 "type": "A String", # Required type of the column.
132 "columnId": 42, # Identifier for the column.
133 "name": "A String", # Required name of the column.
134 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
135 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
136 "columnId": 42, # The id of the column in the base table from which this column is derived.
137 },
138 },
139 ],
140 "name": "A String", # Name assigned to a table.
141 }</pre>
142</div>
143
144<div class="method">
145 <code class="details" id="insert">insert(body)</code>
146 <pre>Creates a new table.
147
148Args:
149 body: object, The request body. (required)
150 The object takes the form of:
151
152{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
153 "kind": "fusiontables#table", # Type name: a template for an individual table.
154 "attribution": "A String", # Optional attribution assigned to the table.
155 "description": "A String", # Optional description assigned to the table.
156 "isExportable": True or False, # Variable for whether table is exportable.
157 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
158 "A String",
159 ],
160 "attributionLink": "A String", # Optional link for attribution.
161 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
162 "columns": [ # Columns in the table.
163 { # Specifies the id, name and type of a column in a table.
164 "kind": "fusiontables#column", # Type name: a template for an individual column.
165 "type": "A String", # Required type of the column.
166 "columnId": 42, # Identifier for the column.
167 "name": "A String", # Required name of the column.
168 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
169 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
170 "columnId": 42, # The id of the column in the base table from which this column is derived.
171 },
172 },
173 ],
174 "name": "A String", # Name assigned to a table.
175 }
176
177
178Returns:
179 An object of the form:
180
181 { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
182 "kind": "fusiontables#table", # Type name: a template for an individual table.
183 "attribution": "A String", # Optional attribution assigned to the table.
184 "description": "A String", # Optional description assigned to the table.
185 "isExportable": True or False, # Variable for whether table is exportable.
186 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
187 "A String",
188 ],
189 "attributionLink": "A String", # Optional link for attribution.
190 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
191 "columns": [ # Columns in the table.
192 { # Specifies the id, name and type of a column in a table.
193 "kind": "fusiontables#column", # Type name: a template for an individual column.
194 "type": "A String", # Required type of the column.
195 "columnId": 42, # Identifier for the column.
196 "name": "A String", # Required name of the column.
197 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
198 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
199 "columnId": 42, # The id of the column in the base table from which this column is derived.
200 },
201 },
202 ],
203 "name": "A String", # Name assigned to a table.
204 }</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
209 <pre>Retrieves a list of tables a user owns.
210
211Args:
212 pageToken: string, Continuation token specifying which result page to return. Optional.
213 maxResults: integer, Maximum number of styles to return. Optional. Default is 5.
214
215Returns:
216 An object of the form:
217
218 { # Represents a list of tables.
219 "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
220 "items": [ # List of all requested tables.
221 { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
222 "kind": "fusiontables#table", # Type name: a template for an individual table.
223 "attribution": "A String", # Optional attribution assigned to the table.
224 "description": "A String", # Optional description assigned to the table.
225 "isExportable": True or False, # Variable for whether table is exportable.
226 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
227 "A String",
228 ],
229 "attributionLink": "A String", # Optional link for attribution.
230 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
231 "columns": [ # Columns in the table.
232 { # Specifies the id, name and type of a column in a table.
233 "kind": "fusiontables#column", # Type name: a template for an individual column.
234 "type": "A String", # Required type of the column.
235 "columnId": 42, # Identifier for the column.
236 "name": "A String", # Required name of the column.
237 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
238 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
239 "columnId": 42, # The id of the column in the base table from which this column is derived.
240 },
241 },
242 ],
243 "name": "A String", # Name assigned to a table.
244 },
245 ],
246 "kind": "fusiontables#tableList", # Type name: a list of all tables.
247 }</pre>
248</div>
249
250<div class="method">
251 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
252 <pre>Retrieves the next page of results.
253
254Args:
255 previous_request: The request for the previous page. (required)
256 previous_response: The response from the request for the previous page. (required)
257
258Returns:
259 A request object that you can call 'execute()' on to request the next
260 page. Returns None if there are no more items in the collection.
261 </pre>
262</div>
263
264<div class="method">
265 <code class="details" id="patch">patch(tableId, body, replaceViewDefinition=None)</code>
266 <pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.
267
268Args:
269 tableId: string, Id of the table that is being updated. (required)
270 body: object, The request body. (required)
271 The object takes the form of:
272
273{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
274 "kind": "fusiontables#table", # Type name: a template for an individual table.
275 "attribution": "A String", # Optional attribution assigned to the table.
276 "description": "A String", # Optional description assigned to the table.
277 "isExportable": True or False, # Variable for whether table is exportable.
278 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
279 "A String",
280 ],
281 "attributionLink": "A String", # Optional link for attribution.
282 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
283 "columns": [ # Columns in the table.
284 { # Specifies the id, name and type of a column in a table.
285 "kind": "fusiontables#column", # Type name: a template for an individual column.
286 "type": "A String", # Required type of the column.
287 "columnId": 42, # Identifier for the column.
288 "name": "A String", # Required name of the column.
289 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
290 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
291 "columnId": 42, # The id of the column in the base table from which this column is derived.
292 },
293 },
294 ],
295 "name": "A String", # Name assigned to a table.
296 }
297
298 replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
299
300Returns:
301 An object of the form:
302
303 { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
304 "kind": "fusiontables#table", # Type name: a template for an individual table.
305 "attribution": "A String", # Optional attribution assigned to the table.
306 "description": "A String", # Optional description assigned to the table.
307 "isExportable": True or False, # Variable for whether table is exportable.
308 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
309 "A String",
310 ],
311 "attributionLink": "A String", # Optional link for attribution.
312 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
313 "columns": [ # Columns in the table.
314 { # Specifies the id, name and type of a column in a table.
315 "kind": "fusiontables#column", # Type name: a template for an individual column.
316 "type": "A String", # Required type of the column.
317 "columnId": 42, # Identifier for the column.
318 "name": "A String", # Required name of the column.
319 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
320 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
321 "columnId": 42, # The id of the column in the base table from which this column is derived.
322 },
323 },
324 ],
325 "name": "A String", # Name assigned to a table.
326 }</pre>
327</div>
328
329<div class="method">
330 <code class="details" id="update">update(tableId, body, replaceViewDefinition=None)</code>
331 <pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.
332
333Args:
334 tableId: string, Id of the table that is being updated. (required)
335 body: object, The request body. (required)
336 The object takes the form of:
337
338{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
339 "kind": "fusiontables#table", # Type name: a template for an individual table.
340 "attribution": "A String", # Optional attribution assigned to the table.
341 "description": "A String", # Optional description assigned to the table.
342 "isExportable": True or False, # Variable for whether table is exportable.
343 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
344 "A String",
345 ],
346 "attributionLink": "A String", # Optional link for attribution.
347 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
348 "columns": [ # Columns in the table.
349 { # Specifies the id, name and type of a column in a table.
350 "kind": "fusiontables#column", # Type name: a template for an individual column.
351 "type": "A String", # Required type of the column.
352 "columnId": 42, # Identifier for the column.
353 "name": "A String", # Required name of the column.
354 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
355 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
356 "columnId": 42, # The id of the column in the base table from which this column is derived.
357 },
358 },
359 ],
360 "name": "A String", # Name assigned to a table.
361 }
362
363 replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
364
365Returns:
366 An object of the form:
367
368 { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
369 "kind": "fusiontables#table", # Type name: a template for an individual table.
370 "attribution": "A String", # Optional attribution assigned to the table.
371 "description": "A String", # Optional description assigned to the table.
372 "isExportable": True or False, # Variable for whether table is exportable.
373 "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
374 "A String",
375 ],
376 "attributionLink": "A String", # Optional link for attribution.
377 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
378 "columns": [ # Columns in the table.
379 { # Specifies the id, name and type of a column in a table.
380 "kind": "fusiontables#column", # Type name: a template for an individual column.
381 "type": "A String", # Required type of the column.
382 "columnId": 42, # Identifier for the column.
383 "name": "A String", # Required name of the column.
384 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
385 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
386 "columnId": 42, # The id of the column in the base table from which this column is derived.
387 },
388 },
389 ],
390 "name": "A String", # Name assigned to a table.
391 }</pre>
392</div>
393
394</body></html>