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