Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c7e5baeb6d6563a43247cd6d314c1bad8b794d35 / . / docs / dyn / area120tables_v1alpha1.tables.html
blob: ec2b232d39617805d8188f8c3f1d162d9b0805df [file] [log] [blame]
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[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="area120tables_v1alpha1.html">Area120 Tables API</a> . <a href="area120tables_v1alpha1.tables.html">tables</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="area120tables_v1alpha1.tables.rows.html">rows()</a></code>
79</p>
80<p class="firstline">Returns the rows Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Gets a table. Returns NOT_FOUND if the table does not exist.</p>
88<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]89 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]90<p class="firstline">Lists tables for the user.</p>
91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
96 <code class="details" id="close">close()</code>
97 <pre>Close httplib2 connections.</pre>
98</div>
99
100<div class="method">
101 <code class="details" id="get">get(name, x__xgafv=None)</code>
102 <pre>Gets a table. Returns NOT_FOUND if the table does not exist.
103
104Args:
105 name: string, Required. The name of the table to retrieve. Format: tables/{table} (required)
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]114 { # A single table. NextId: 7
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]115 &quot;columns&quot;: [ # List of columns in this table. Order of columns matches the display order.
116 { # Details on a column in the table.
117 &quot;dataType&quot;: &quot;A String&quot;, # Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website.
118 &quot;id&quot;: &quot;A String&quot;, # Internal id for a column.
119 &quot;labels&quot;: [ # Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation.
120 { # A single item in a labeled column.
121 &quot;id&quot;: &quot;A String&quot;, # Internal id associated with the item.
122 &quot;name&quot;: &quot;A String&quot;, # Display string as entered by user.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]123 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]124 ],
125 &quot;lookupDetails&quot;: { # Details about a lookup column whose value comes from the associated relationship. # Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column.
126 &quot;relationshipColumn&quot;: &quot;A String&quot;, # The name of the relationship column associated with the lookup.
127 &quot;relationshipColumnId&quot;: &quot;A String&quot;, # The id of the relationship column.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]128 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]129 &quot;name&quot;: &quot;A String&quot;, # column name
130 &quot;relationshipDetails&quot;: { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship.
131 &quot;linkedTable&quot;: &quot;A String&quot;, # The name of the table this relationship is linked to.
132 },
133 },
134 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]135 &quot;createTime&quot;: &quot;A String&quot;, # Time when the table was created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]136 &quot;displayName&quot;: &quot;A String&quot;, # The human readable title of the table.
137 &quot;name&quot;: &quot;A String&quot;, # The resource name of the table. Table names have the form `tables/{table}`.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]138 &quot;savedViews&quot;: [ # Saved views for this table.
139 { # A saved view of a table. NextId: 3
140 &quot;id&quot;: &quot;A String&quot;, # Internal id associated with the saved view.
141 &quot;name&quot;: &quot;A String&quot;, # Display name of the saved view.
142 },
143 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]144 &quot;updateTime&quot;: &quot;A String&quot;, # Time when the table was last updated excluding updates to individual rows
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]145}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]146</div>
147
148<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]149 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]150 <pre>Lists tables for the user.
151
152Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]153 pageSize: integer, The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]154 pageToken: string, A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]155 x__xgafv: string, V1 error format.
156 Allowed values
157 1 - v1 error format
158 2 - v2 error format
159
160Returns:
161 An object of the form:
162
163 { # Response message for TablesService.ListTables.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]164 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.
165 &quot;tables&quot;: [ # The list of tables.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]166 { # A single table. NextId: 7
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]167 &quot;columns&quot;: [ # List of columns in this table. Order of columns matches the display order.
168 { # Details on a column in the table.
169 &quot;dataType&quot;: &quot;A String&quot;, # Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website.
170 &quot;id&quot;: &quot;A String&quot;, # Internal id for a column.
171 &quot;labels&quot;: [ # Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation.
172 { # A single item in a labeled column.
173 &quot;id&quot;: &quot;A String&quot;, # Internal id associated with the item.
174 &quot;name&quot;: &quot;A String&quot;, # Display string as entered by user.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]175 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]176 ],
177 &quot;lookupDetails&quot;: { # Details about a lookup column whose value comes from the associated relationship. # Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column.
178 &quot;relationshipColumn&quot;: &quot;A String&quot;, # The name of the relationship column associated with the lookup.
179 &quot;relationshipColumnId&quot;: &quot;A String&quot;, # The id of the relationship column.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]180 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]181 &quot;name&quot;: &quot;A String&quot;, # column name
182 &quot;relationshipDetails&quot;: { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship.
183 &quot;linkedTable&quot;: &quot;A String&quot;, # The name of the table this relationship is linked to.
184 },
185 },
186 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]187 &quot;createTime&quot;: &quot;A String&quot;, # Time when the table was created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]188 &quot;displayName&quot;: &quot;A String&quot;, # The human readable title of the table.
189 &quot;name&quot;: &quot;A String&quot;, # The resource name of the table. Table names have the form `tables/{table}`.
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400[diff] [blame]190 &quot;savedViews&quot;: [ # Saved views for this table.
191 { # A saved view of a table. NextId: 3
192 &quot;id&quot;: &quot;A String&quot;, # Internal id associated with the saved view.
193 &quot;name&quot;: &quot;A String&quot;, # Display name of the saved view.
194 },
195 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]196 &quot;updateTime&quot;: &quot;A String&quot;, # Time when the table was last updated excluding updates to individual rows
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]197 },
198 ],
199}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]200</div>
201
202<div class="method">
203 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
204 <pre>Retrieves the next page of results.
205
206Args:
207 previous_request: The request for the previous page. (required)
208 previous_response: The response from the request for the previous page. (required)
209
210Returns:
211 A request object that you can call &#x27;execute()&#x27; on to request the next
212 page. Returns None if there are no more items in the collection.
213 </pre>
214</div>
215
216</body></html>