Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / fusiontables_v1.column.html
blob: 3258943f4f445be22e1568f9bfc6a764cb0c03a9 [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="fusiontables_v1.html">Fusion Tables API</a> . <a href="fusiontables_v1.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 id, name and type of a column in a table.
121 "kind": "fusiontables#column", # Type name: a template for an individual column.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]122 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]123 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
124 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
125 "columnId": 42, # The id of the column in the base table from which this column is derived.
126 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]127 "columnId": 42, # Identifier for the column.
128 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
129 "type": "A String", # Required type of the column.
130 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="insert">insert(tableId, body)</code>
136 <pre>Adds a new column to the table.
137
138Args:
139 tableId: string, Table for which a new column is being added. (required)
140 body: object, The request body. (required)
141 The object takes the form of:
142
143{ # Specifies the id, name and type of a column in a table.
144 "kind": "fusiontables#column", # Type name: a template for an individual column.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]145 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]146 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
147 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
148 "columnId": 42, # The id of the column in the base table from which this column is derived.
149 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]150 "columnId": 42, # Identifier for the column.
151 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
152 "type": "A String", # Required type of the column.
153 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]154 }
155
156
157Returns:
158 An object of the form:
159
160 { # Specifies the id, name and type of a column in a table.
161 "kind": "fusiontables#column", # Type name: a template for an individual column.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]162 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
164 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
165 "columnId": 42, # The id of the column in the base table from which this column is derived.
166 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]167 "columnId": 42, # Identifier for the column.
168 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
169 "type": "A String", # Required type of the column.
170 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="list">list(tableId, pageToken=None, maxResults=None)</code>
176 <pre>Retrieves a list of columns.
177
178Args:
179 tableId: string, Table whose columns are being listed. (required)
180 pageToken: string, Continuation token specifying which result page to return. Optional.
181 maxResults: integer, Maximum number of columns to return. Optional. Default is 5.
182
183Returns:
184 An object of the form:
185
186 { # Represents a list of columns in a table.
187 "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
188 "items": [ # List of all requested columns.
189 { # Specifies the id, name and type of a column in a table.
190 "kind": "fusiontables#column", # Type name: a template for an individual column.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]191 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]192 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
193 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
194 "columnId": 42, # The id of the column in the base table from which this column is derived.
195 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]196 "columnId": 42, # Identifier for the column.
197 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
198 "type": "A String", # Required type of the column.
199 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]200 },
201 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]202 "kind": "fusiontables#columnList", # Type name: a list of all columns.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]203 "totalItems": 42, # Total number of columns for the table.
204 }</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
209 <pre>Retrieves the next page of results.
210
211Args:
212 previous_request: The request for the previous page. (required)
213 previous_response: The response from the request for the previous page. (required)
214
215Returns:
216 A request object that you can call 'execute()' on to request the next
217 page. Returns None if there are no more items in the collection.
218 </pre>
219</div>
220
221<div class="method">
222 <code class="details" id="patch">patch(tableId, columnId, body)</code>
223 <pre>Updates the name or type of an existing column. This method supports patch semantics.
224
225Args:
226 tableId: string, Table for which the column is being updated. (required)
227 columnId: string, Name or identifier for the column that is being updated. (required)
228 body: object, The request body. (required)
229 The object takes the form of:
230
231{ # Specifies the id, name and type of a column in a table.
232 "kind": "fusiontables#column", # Type name: a template for an individual column.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]233 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]234 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
235 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
236 "columnId": 42, # The id of the column in the base table from which this column is derived.
237 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]238 "columnId": 42, # Identifier for the column.
239 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
240 "type": "A String", # Required type of the column.
241 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]242 }
243
244
245Returns:
246 An object of the form:
247
248 { # Specifies the id, name and type of a column in a table.
249 "kind": "fusiontables#column", # Type name: a template for an individual column.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]250 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]251 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
252 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
253 "columnId": 42, # The id of the column in the base table from which this column is derived.
254 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]255 "columnId": 42, # Identifier for the column.
256 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
257 "type": "A String", # Required type of the column.
258 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]259 }</pre>
260</div>
261
262<div class="method">
263 <code class="details" id="update">update(tableId, columnId, body)</code>
264 <pre>Updates the name or type of an existing column.
265
266Args:
267 tableId: string, Table for which the column is being updated. (required)
268 columnId: string, Name or identifier for the column that is being updated. (required)
269 body: object, The request body. (required)
270 The object takes the form of:
271
272{ # Specifies the id, name and type of a column in a table.
273 "kind": "fusiontables#column", # Type name: a template for an individual column.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]274 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]275 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
276 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
277 "columnId": 42, # The id of the column in the base table from which this column is derived.
278 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]279 "columnId": 42, # Identifier for the column.
280 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
281 "type": "A String", # Required type of the column.
282 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]283 }
284
285
286Returns:
287 An object of the form:
288
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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]291 "description": "A String", # Optional column description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]292 "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
293 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
294 "columnId": 42, # The id of the column in the base table from which this column is derived.
295 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]296 "columnId": 42, # Identifier for the column.
297 "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
298 "type": "A String", # Required type of the column.
299 "name": "A String", # Required name of the column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]300 }</pre>
301</div>
302
303</body></html>