Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / af918e8ef422438aaca0c468de8b3b2c184d884e / . / docs / dyn / script_v1.processes.html
blob: a7cf922e3201bdd6a2dce05ac1a4d5f14fe18249 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="script_v1.html">Apps Script API</a> . <a href="script_v1.processes.html">processes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]81 <code><a href="#list">list(userProcessFilter_types=None, userProcessFilter_deploymentId=None, userProcessFilter_startTime=None, userProcessFilter_userAccessLevels=None, pageToken=None, userProcessFilter_scriptId=None, userProcessFilter_statuses=None, userProcessFilter_projectName=None, pageSize=None, userProcessFilter_functionName=None, userProcessFilter_endTime=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">List information about processes made by or on behalf of a user, such as process type and current status.</p>
83<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]84 <code><a href="#listScriptProcesses">listScriptProcesses(scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_types=None, scriptProcessFilter_userAccessLevels=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_startTime=None, scriptId=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">List information about a script's executed processes, such as process type and current status.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</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<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]99 <code class="details" id="list">list(userProcessFilter_types=None, userProcessFilter_deploymentId=None, userProcessFilter_startTime=None, userProcessFilter_userAccessLevels=None, pageToken=None, userProcessFilter_scriptId=None, userProcessFilter_statuses=None, userProcessFilter_projectName=None, pageSize=None, userProcessFilter_functionName=None, userProcessFilter_endTime=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>List information about processes made by or on behalf of a user, such as process type and current status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 userProcessFilter_types: string, Optional field used to limit returned processes to those having one of the specified process types. (repeated)
104 Allowed values
105 PROCESS_TYPE_UNSPECIFIED - Unspecified type.
106 ADD_ON - The process was started from an add-on entry point.
107 EXECUTION_API - The process was started using the Apps Script API.
108 TIME_DRIVEN - The process was started from a time-based trigger.
109 TRIGGER - The process was started from an event-based trigger.
110 WEBAPP - The process was started from a web app entry point.
111 EDITOR - The process was started using the Apps Script IDE.
112 SIMPLE_TRIGGER - The process was started from a G Suite simple trigger.
113 MENU - The process was started from a G Suite menu item.
114 BATCH_TASK - The process was started as a task in a batch job.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]115 userProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
116 userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were started on or after the given timestamp.
117 userProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of the specified user access levels. (repeated)
118 Allowed values
119 USER_ACCESS_LEVEL_UNSPECIFIED - User access level unspecified
120 NONE - The user has no access.
121 READ - The user has read-only access.
122 WRITE - The user has write access.
123 OWNER - The user is an owner.
124 pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
125 userProcessFilter_scriptId: string, Optional field used to limit returned processes to those originating from projects with a specific script ID.
126 userProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of the specified process statuses. (repeated)
127 Allowed values
128 PROCESS_STATUS_UNSPECIFIED - Unspecified status.
129 RUNNING - The process is currently running.
130 PAUSED - The process has paused.
131 COMPLETED - The process has completed.
132 CANCELED - The process was cancelled.
133 FAILED - The process failed.
134 TIMED_OUT - The process timed out.
135 UNKNOWN - Process status unknown.
136 DELAYED - The process is delayed, waiting for quota.
137 userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from projects with project names containing a specific string.
138 pageSize: integer, The maximum number of returned processes per page of results. Defaults to 50.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]139 userProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from a script function with the given function name.
140 userProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed on or before the given timestamp.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145
146Returns:
147 An object of the form:
148
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]149 { # Response with the list of Process resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]150 &quot;processes&quot;: [ # List of processes matching request parameters.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]151 { # Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 &quot;startTime&quot;: &quot;A String&quot;, # Time the execution started.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]153 &quot;userAccessLevel&quot;: &quot;A String&quot;, # The executing users access level to the script.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]154 &quot;functionName&quot;: &quot;A String&quot;, # Name of the function the started the execution.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]155 &quot;projectName&quot;: &quot;A String&quot;, # Name of the script being executed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156 &quot;processStatus&quot;: &quot;A String&quot;, # The executions status.
157 &quot;duration&quot;: &quot;A String&quot;, # Duration the execution spent executing.
158 &quot;processType&quot;: &quot;A String&quot;, # The executions type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 },
160 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]161 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token for the next page of results. If empty, there are no more pages remaining.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 }</pre>
163</div>
164
165<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]166 <code class="details" id="listScriptProcesses">listScriptProcesses(scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_types=None, scriptProcessFilter_userAccessLevels=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_startTime=None, scriptId=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]167 <pre>List information about a script&#x27;s executed processes, such as process type and current status.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168
169Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]170 scriptProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed on or before the given timestamp.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]171 scriptProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from a script function with the given function name.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]172 scriptProcessFilter_types: string, Optional field used to limit returned processes to those having one of the specified process types. (repeated)
173 Allowed values
174 PROCESS_TYPE_UNSPECIFIED - Unspecified type.
175 ADD_ON - The process was started from an add-on entry point.
176 EXECUTION_API - The process was started using the Apps Script API.
177 TIME_DRIVEN - The process was started from a time-based trigger.
178 TRIGGER - The process was started from an event-based trigger.
179 WEBAPP - The process was started from a web app entry point.
180 EDITOR - The process was started using the Apps Script IDE.
181 SIMPLE_TRIGGER - The process was started from a G Suite simple trigger.
182 MENU - The process was started from a G Suite menu item.
183 BATCH_TASK - The process was started as a task in a batch job.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]184 scriptProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of the specified user access levels. (repeated)
185 Allowed values
186 USER_ACCESS_LEVEL_UNSPECIFIED - User access level unspecified
187 NONE - The user has no access.
188 READ - The user has read-only access.
189 WRITE - The user has write access.
190 OWNER - The user is an owner.
191 pageSize: integer, The maximum number of returned processes per page of results. Defaults to 50.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]192 scriptProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of the specified process statuses. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]193 Allowed values
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]194 PROCESS_STATUS_UNSPECIFIED - Unspecified status.
195 RUNNING - The process is currently running.
196 PAUSED - The process has paused.
197 COMPLETED - The process has completed.
198 CANCELED - The process was cancelled.
199 FAILED - The process failed.
200 TIMED_OUT - The process timed out.
201 UNKNOWN - Process status unknown.
202 DELAYED - The process is delayed, waiting for quota.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]203 scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
204 scriptProcessFilter_startTime: string, Optional field used to limit returned processes to those that were started on or after the given timestamp.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]205 scriptId: string, The script ID of the project whose processes are listed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]206 pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211
212Returns:
213 An object of the form:
214
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]215 { # Response with the list of Process resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 &quot;processes&quot;: [ # List of processes matching request parameters.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]217 { # Representation of a single script process execution that was started from the script editor, a trigger, an application, or using the Apps Script API. This is distinct from the `Operation` resource, which only represents executions started via the Apps Script API.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]218 &quot;startTime&quot;: &quot;A String&quot;, # Time the execution started.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]219 &quot;userAccessLevel&quot;: &quot;A String&quot;, # The executing users access level to the script.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]220 &quot;functionName&quot;: &quot;A String&quot;, # Name of the function the started the execution.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]221 &quot;projectName&quot;: &quot;A String&quot;, # Name of the script being executed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]222 &quot;processStatus&quot;: &quot;A String&quot;, # The executions status.
223 &quot;duration&quot;: &quot;A String&quot;, # Duration the execution spent executing.
224 &quot;processType&quot;: &quot;A String&quot;, # The executions type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 },
226 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]227 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token for the next page of results. If empty, there are no more pages remaining.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 }</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</code>
233 <pre>Retrieves the next page of results.
234
235Args:
236 previous_request: The request for the previous page. (required)
237 previous_response: The response from the request for the previous page. (required)
238
239Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]241 page. Returns None if there are no more items in the collection.
242 </pre>
243</div>
244
245<div class="method">
246 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
247 <pre>Retrieves the next page of results.
248
249Args:
250 previous_request: The request for the previous page. (required)
251 previous_response: The response from the request for the previous page. (required)
252
253Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]254 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 page. Returns None if there are no more items in the collection.
256 </pre>
257</div>
258
259</body></html>