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