Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / fusiontables_v2.task.html
blob: 55e2a3e56f44c32d26073b303d4b8eccdf9d494b [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.task.html">task</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(tableId, taskId)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]79<p class="firstline">Deletes a specific task by its ID, unless that task has already started running.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(tableId, taskId)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]82<p class="firstline">Retrieves a specific task by its ID.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]83<p class="toc_element">
84 <code><a href="#list">list(tableId, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
85<p class="firstline">Retrieves a list of tasks.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(tableId, taskId)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]92 <pre>Deletes a specific task by its ID, unless that task has already started running.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]93
94Args:
95 tableId: string, Table from which the task is being deleted. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]96 taskId: string, The identifier of the task to delete. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]97</pre>
98</div>
99
100<div class="method">
101 <code class="details" id="get">get(tableId, taskId)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]102 <pre>Retrieves a specific task by its ID.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]103
104Args:
105 tableId: string, Table to which the task belongs. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]106 taskId: string, The identifier of the task to get. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]107
108Returns:
109 An object of the form:
110
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]111 { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
112 "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]113 "progress": "A String", # Task percentage completion.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]114 "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
115 "type": "A String", # Type of background task.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]116 "taskId": "A String", # Identifier for the task.
117 }</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="list">list(tableId, pageToken=None, maxResults=None, startIndex=None)</code>
122 <pre>Retrieves a list of tasks.
123
124Args:
125 tableId: string, Table whose tasks are being listed. (required)
126 pageToken: string, Continuation token specifying which result page to return.
127 maxResults: integer, Maximum number of tasks to return. Default is 5.
128 startIndex: integer, Index of the first result returned in the current page.
129
130Returns:
131 An object of the form:
132
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]133 { # Represents a list of tasks for a table.
134 "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]135 "items": [ # List of all requested tasks.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]136 { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
137 "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]138 "progress": "A String", # Task percentage completion.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]139 "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
140 "type": "A String", # Type of background task.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]141 "taskId": "A String", # Identifier for the task.
142 },
143 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]144 "kind": "fusiontables#taskList", # Type of the resource. This is always "fusiontables#taskList".
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]145 "totalItems": 42, # Total number of tasks for the table.
146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
151 <pre>Retrieves the next page of results.
152
153Args:
154 previous_request: The request for the previous page. (required)
155 previous_response: The response from the request for the previous page. (required)
156
157Returns:
158 A request object that you can call 'execute()' on to request the next
159 page. Returns None if there are no more items in the collection.
160 </pre>
161</div>
162
163</body></html>