Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c9b6cec70b2162b98d836f8100bc039f19fe23cb / . / docs / dyn / fusiontables_v2.column.html
blob: 6fc0a8abee0a46306cc554a7d29f5055422691c8 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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_v2.html">Fusion Tables API</a> . <a href="fusiontables_v2.column.html">column</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(tableId, columnId)</a></code></p>
79<p class="firstline">Deletes the column.</p>
80<p class="toc_element">
81 <code><a href="#get">get(tableId, columnId)</a></code></p>
82<p class="firstline">Retrieves a specific column by its id.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(tableId, body)</a></code></p>
85<p class="firstline">Adds a new column to the table.</p>
86<p class="toc_element">
87 <code><a href="#list">list(tableId, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Retrieves a list of columns.</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, columnId, body)</a></code></p>
94<p class="firstline">Updates the name or type of an existing column. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(tableId, columnId, body)</a></code></p>
97<p class="firstline">Updates the name or type of an existing column.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(tableId, columnId)</code>
101 <pre>Deletes the column.
102
103Args:
104 tableId: string, Table from which the column is being deleted. (required)
105 columnId: string, Name or identifier for the column being deleted. (required)
106</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="get">get(tableId, columnId)</code>
111 <pre>Retrieves a specific column by its id.
112
113Args:
114 tableId: string, Table to which the column belongs. (required)
115 columnId: string, Name or identifier for the column that is being requested. (required)
116
117Returns:
118 An object of the form:
119
120 { # Specifies the details of a column in a table.
121 "graphPredicate": "A String", # Column graph predicate.
122 # Used to map table to graph data model (subject,predicate,object)
123 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
124 "kind": "fusiontables#column", # Type name: a template for an individual column.
125 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
126 "A String",
127 ],
128 "description": "A String", # Column description.
129 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
130 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
131 "columnId": 42, # The id of the column in the base table from which this column is derived.
132 },
133 "name": "A String", # Name of the column.
134 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
135 "formatPattern": "A String", # Format pattern.
136 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
137 "type": "A String", # Type of the column.
138 "validateData": True or False, # If true, data entered via the web application is validated.
139 "columnId": 42, # Identifier for the column.
140 }</pre>
141</div>
142
143<div class="method">
144 <code class="details" id="insert">insert(tableId, body)</code>
145 <pre>Adds a new column to the table.
146
147Args:
148 tableId: string, Table for which a new column is being added. (required)
149 body: object, The request body. (required)
150 The object takes the form of:
151
152{ # Specifies the details of a column in a table.
153 "graphPredicate": "A String", # Column graph predicate.
154 # Used to map table to graph data model (subject,predicate,object)
155 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
156 "kind": "fusiontables#column", # Type name: a template for an individual column.
157 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
158 "A String",
159 ],
160 "description": "A String", # Column description.
161 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
162 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
163 "columnId": 42, # The id of the column in the base table from which this column is derived.
164 },
165 "name": "A String", # Name of the column.
166 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
167 "formatPattern": "A String", # Format pattern.
168 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
169 "type": "A String", # Type of the column.
170 "validateData": True or False, # If true, data entered via the web application is validated.
171 "columnId": 42, # Identifier for the column.
172 }
173
174
175Returns:
176 An object of the form:
177
178 { # Specifies the details of a column in a table.
179 "graphPredicate": "A String", # Column graph predicate.
180 # Used to map table to graph data model (subject,predicate,object)
181 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
182 "kind": "fusiontables#column", # Type name: a template for an individual column.
183 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
184 "A String",
185 ],
186 "description": "A String", # Column description.
187 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
188 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
189 "columnId": 42, # The id of the column in the base table from which this column is derived.
190 },
191 "name": "A String", # Name of the column.
192 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
193 "formatPattern": "A String", # Format pattern.
194 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
195 "type": "A String", # Type of the column.
196 "validateData": True or False, # If true, data entered via the web application is validated.
197 "columnId": 42, # Identifier for the column.
198 }</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="list">list(tableId, pageToken=None, maxResults=None)</code>
203 <pre>Retrieves a list of columns.
204
205Args:
206 tableId: string, Table whose columns are being listed. (required)
207 pageToken: string, Continuation token specifying which result page to return.
208 maxResults: integer, Maximum number of columns to return. Default is 5.
209
210Returns:
211 An object of the form:
212
213 { # Represents a list of columns in a table.
214 "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
215 "items": [ # List of all requested columns.
216 { # Specifies the details of a column in a table.
217 "graphPredicate": "A String", # Column graph predicate.
218 # Used to map table to graph data model (subject,predicate,object)
219 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
220 "kind": "fusiontables#column", # Type name: a template for an individual column.
221 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
222 "A String",
223 ],
224 "description": "A String", # Column description.
225 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
226 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
227 "columnId": 42, # The id of the column in the base table from which this column is derived.
228 },
229 "name": "A String", # Name of the column.
230 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
231 "formatPattern": "A String", # Format pattern.
232 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
233 "type": "A String", # Type of the column.
234 "validateData": True or False, # If true, data entered via the web application is validated.
235 "columnId": 42, # Identifier for the column.
236 },
237 ],
238 "kind": "fusiontables#columnList", # Type name: a list of all columns.
239 "totalItems": 42, # Total number of columns for the table.
240 }</pre>
241</div>
242
243<div class="method">
244 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
245 <pre>Retrieves the next page of results.
246
247Args:
248 previous_request: The request for the previous page. (required)
249 previous_response: The response from the request for the previous page. (required)
250
251Returns:
252 A request object that you can call 'execute()' on to request the next
253 page. Returns None if there are no more items in the collection.
254 </pre>
255</div>
256
257<div class="method">
258 <code class="details" id="patch">patch(tableId, columnId, body)</code>
259 <pre>Updates the name or type of an existing column. This method supports patch semantics.
260
261Args:
262 tableId: string, Table for which the column is being updated. (required)
263 columnId: string, Name or identifier for the column that is being updated. (required)
264 body: object, The request body. (required)
265 The object takes the form of:
266
267{ # Specifies the details of a column in a table.
268 "graphPredicate": "A String", # Column graph predicate.
269 # Used to map table to graph data model (subject,predicate,object)
270 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
271 "kind": "fusiontables#column", # Type name: a template for an individual column.
272 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
273 "A String",
274 ],
275 "description": "A String", # Column description.
276 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
277 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
278 "columnId": 42, # The id of the column in the base table from which this column is derived.
279 },
280 "name": "A String", # Name of the column.
281 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
282 "formatPattern": "A String", # Format pattern.
283 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
284 "type": "A String", # Type of the column.
285 "validateData": True or False, # If true, data entered via the web application is validated.
286 "columnId": 42, # Identifier for the column.
287 }
288
289
290Returns:
291 An object of the form:
292
293 { # Specifies the details of a column in a table.
294 "graphPredicate": "A String", # Column graph predicate.
295 # Used to map table to graph data model (subject,predicate,object)
296 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
297 "kind": "fusiontables#column", # Type name: a template for an individual column.
298 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
299 "A String",
300 ],
301 "description": "A String", # Column description.
302 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
303 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
304 "columnId": 42, # The id of the column in the base table from which this column is derived.
305 },
306 "name": "A String", # Name of the column.
307 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
308 "formatPattern": "A String", # Format pattern.
309 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
310 "type": "A String", # Type of the column.
311 "validateData": True or False, # If true, data entered via the web application is validated.
312 "columnId": 42, # Identifier for the column.
313 }</pre>
314</div>
315
316<div class="method">
317 <code class="details" id="update">update(tableId, columnId, body)</code>
318 <pre>Updates the name or type of an existing column.
319
320Args:
321 tableId: string, Table for which the column is being updated. (required)
322 columnId: string, Name or identifier for the column that is being updated. (required)
323 body: object, The request body. (required)
324 The object takes the form of:
325
326{ # Specifies the details of a column in a table.
327 "graphPredicate": "A String", # Column graph predicate.
328 # Used to map table to graph data model (subject,predicate,object)
329 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
330 "kind": "fusiontables#column", # Type name: a template for an individual column.
331 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
332 "A String",
333 ],
334 "description": "A String", # Column description.
335 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
336 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
337 "columnId": 42, # The id of the column in the base table from which this column is derived.
338 },
339 "name": "A String", # Name of the column.
340 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
341 "formatPattern": "A String", # Format pattern.
342 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
343 "type": "A String", # Type of the column.
344 "validateData": True or False, # If true, data entered via the web application is validated.
345 "columnId": 42, # Identifier for the column.
346 }
347
348
349Returns:
350 An object of the form:
351
352 { # Specifies the details of a column in a table.
353 "graphPredicate": "A String", # Column graph predicate.
354 # Used to map table to graph data model (subject,predicate,object)
355 # See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
356 "kind": "fusiontables#column", # Type name: a template for an individual column.
357 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
358 "A String",
359 ],
360 "description": "A String", # Column description.
361 "baseColumn": { # 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 "name": "A String", # Name of the column.
366 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
367 "formatPattern": "A String", # Format pattern.
368 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
369 "type": "A String", # Type of the column.
370 "validateData": True or False, # If true, data entered via the web application is validated.
371 "columnId": 42, # Identifier for the column.
372 }</pre>
373</div>
374
375</body></html>