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