Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / script_v1.processes.html
blob: 61c82b234f8c76330a37abcb1ac49ad2913e18e7 [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#list">list(userProcessFilter_projectName=None, pageSize=None, userProcessFilter_startTime=None, userProcessFilter_types=None, userProcessFilter_scriptId=None, userProcessFilter_endTime=None, userProcessFilter_functionName=None, userProcessFilter_deploymentId=None, userProcessFilter_statuses=None, userProcessFilter_userAccessLevels=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">List information about processes made by or on behalf of a user,</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#listScriptProcesses">listScriptProcesses(scriptProcessFilter_startTime=None, pageSize=None, scriptProcessFilter_functionName=None, scriptId=None, scriptProcessFilter_types=None, scriptProcessFilter_userAccessLevels=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_statuses=None, scriptProcessFilter_endTime=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">List information about a script's executed processes, such as process type</p>
83<p class="toc_element">
84 <code><a href="#listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]91 <code class="details" id="list">list(userProcessFilter_projectName=None, pageSize=None, userProcessFilter_startTime=None, userProcessFilter_types=None, userProcessFilter_scriptId=None, userProcessFilter_endTime=None, userProcessFilter_functionName=None, userProcessFilter_deploymentId=None, userProcessFilter_statuses=None, userProcessFilter_userAccessLevels=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92 <pre>List information about processes made by or on behalf of a user,
93such as process type and current status.
94
95Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]96 userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from
97projects with project names containing a specific string.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 pageSize: integer, The maximum number of returned processes per page of results. Defaults to
9950.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
101started on or after the given timestamp.
102 userProcessFilter_types: string, Optional field used to limit returned processes to those having one of
103the specified process types. (repeated)
104 userProcessFilter_scriptId: string, Optional field used to limit returned processes to those originating from
105projects with a specific script ID.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 userProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
107on or before the given timestamp.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 userProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
109a script function with the given function name.
110 userProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
111projects with a specific deployment ID.
112 userProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
113the specified process statuses. (repeated)
114 userProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
115the specified user access levels. (repeated)
116 pageToken: string, The token for continuing a previous list request on the next page. This
117should be set to the value of `nextPageToken` from a previous response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122
123Returns:
124 An object of the form:
125
126 { # Response with the list of
127 # Process resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128 &quot;processes&quot;: [ # List of processes matching request parameters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 { # Representation of a single script process execution that was started from
130 # the script editor, a trigger, an application, or using the Apps Script API.
131 # This is distinct from the `Operation`
132 # resource, which only represents executions started via the Apps Script API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 &quot;processStatus&quot;: &quot;A String&quot;, # The executions status.
134 &quot;userAccessLevel&quot;: &quot;A String&quot;, # The executing users access level to the script.
135 &quot;projectName&quot;: &quot;A String&quot;, # Name of the script being executed.
136 &quot;startTime&quot;: &quot;A String&quot;, # Time the execution started.
137 &quot;functionName&quot;: &quot;A String&quot;, # Name of the function the started the execution.
138 &quot;duration&quot;: &quot;A String&quot;, # Duration the execution spent executing.
139 &quot;processType&quot;: &quot;A String&quot;, # The executions type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]140 },
141 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token for the next page of results. If empty, there are no more pages
143 # remaining.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 }</pre>
145</div>
146
147<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 <code class="details" id="listScriptProcesses">listScriptProcesses(scriptProcessFilter_startTime=None, pageSize=None, scriptProcessFilter_functionName=None, scriptId=None, scriptProcessFilter_types=None, scriptProcessFilter_userAccessLevels=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_statuses=None, scriptProcessFilter_endTime=None, pageToken=None, x__xgafv=None)</code>
149 <pre>List information about a script&#x27;s executed processes, such as process type
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150and current status.
151
152Args:
153 scriptProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
154started on or after the given timestamp.
155 pageSize: integer, The maximum number of returned processes per page of results. Defaults to
15650.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]157 scriptProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
158a script function with the given function name.
159 scriptId: string, The script ID of the project whose processes are listed.
160 scriptProcessFilter_types: string, Optional field used to limit returned processes to those having one of
161the specified process types. (repeated)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 scriptProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
163the specified user access levels. (repeated)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
165projects with a specific deployment ID.
166 scriptProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
167the specified process statuses. (repeated)
168 scriptProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
169on or before the given timestamp.
170 pageToken: string, The token for continuing a previous list request on the next page. This
171should be set to the value of `nextPageToken` from a previous response.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176
177Returns:
178 An object of the form:
179
180 { # Response with the list of
181 # Process resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &quot;processes&quot;: [ # List of processes matching request parameters.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 { # Representation of a single script process execution that was started from
184 # the script editor, a trigger, an application, or using the Apps Script API.
185 # This is distinct from the `Operation`
186 # resource, which only represents executions started via the Apps Script API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]187 &quot;processStatus&quot;: &quot;A String&quot;, # The executions status.
188 &quot;userAccessLevel&quot;: &quot;A String&quot;, # The executing users access level to the script.
189 &quot;projectName&quot;: &quot;A String&quot;, # Name of the script being executed.
190 &quot;startTime&quot;: &quot;A String&quot;, # Time the execution started.
191 &quot;functionName&quot;: &quot;A String&quot;, # Name of the function the started the execution.
192 &quot;duration&quot;: &quot;A String&quot;, # Duration the execution spent executing.
193 &quot;processType&quot;: &quot;A String&quot;, # The executions type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 },
195 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]196 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token for the next page of results. If empty, there are no more pages
197 # remaining.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 }</pre>
199</div>
200
201<div class="method">
202 <code class="details" id="listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</code>
203 <pre>Retrieves the next page of results.
204
205Args:
206 previous_request: The request for the previous page. (required)
207 previous_response: The response from the request for the previous page. (required)
208
209Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]210 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]211 page. Returns None if there are no more items in the collection.
212 </pre>
213</div>
214
215<div class="method">
216 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
217 <pre>Retrieves the next page of results.
218
219Args:
220 previous_request: The request for the previous page. (required)
221 previous_response: The response from the request for the previous page. (required)
222
223Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]224 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]225 page. Returns None if there are no more items in the collection.
226 </pre>
227</div>
228
229</body></html>