docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/script_v1.processes.html b/docs/dyn/script_v1.processes.html
index e45646c..61c82b2 100644
--- a/docs/dyn/script_v1.processes.html
+++ b/docs/dyn/script_v1.processes.html
@@ -75,10 +75,10 @@
<h1><a href="script_v1.html">Apps Script API</a> . <a href="script_v1.processes.html">processes</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <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>
+ <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>
<p class="firstline">List information about processes made by or on behalf of a user,</p>
<p class="toc_element">
- <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>
+ <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>
<p class="firstline">List information about a script's executed processes, such as process type</p>
<p class="toc_element">
<code><a href="#listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</a></code></p>
@@ -88,65 +88,65 @@
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <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>
+ <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>
<pre>List information about processes made by or on behalf of a user,
such as process type and current status.
Args:
- userProcessFilter_types: string, Optional field used to limit returned processes to those having one of
-the specified process types. (repeated)
- userProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
-the specified user access levels. (repeated)
+ userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from
+projects with project names containing a specific string.
pageSize: integer, The maximum number of returned processes per page of results. Defaults to
50.
+ userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
+started on or after the given timestamp.
+ userProcessFilter_types: string, Optional field used to limit returned processes to those having one of
+the specified process types. (repeated)
+ userProcessFilter_scriptId: string, Optional field used to limit returned processes to those originating from
+projects with a specific script ID.
userProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
on or before the given timestamp.
+ userProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
+a script function with the given function name.
+ userProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
+projects with a specific deployment ID.
+ userProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
+the specified process statuses. (repeated)
+ userProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
+the specified user access levels. (repeated)
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from
-projects with project names containing a specific string.
- 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.
- userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
-started on or after the given timestamp.
- userProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
-projects with a specific deployment ID.
- userProcessFilter_scriptId: string, Optional field used to limit returned processes to those originating from
-projects with a specific script ID.
- userProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
-a script function with the given function name.
- userProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
-the specified process statuses. (repeated)
Returns:
An object of the form:
{ # Response with the list of
# Process resources.
- "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages
- # remaining.
- "processes": [ # List of processes matching request parameters.
+ "processes": [ # List of processes matching request parameters.
{ # 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.
- "processStatus": "A String", # The executions status.
- "userAccessLevel": "A String", # The executing users access level to the script.
- "functionName": "A String", # Name of the function the started the execution.
- "projectName": "A String", # Name of the script being executed.
- "startTime": "A String", # Time the execution started.
- "duration": "A String", # Duration the execution spent executing.
- "processType": "A String", # The executions type.
+ "processStatus": "A String", # The executions status.
+ "userAccessLevel": "A String", # The executing users access level to the script.
+ "projectName": "A String", # Name of the script being executed.
+ "startTime": "A String", # Time the execution started.
+ "functionName": "A String", # Name of the function the started the execution.
+ "duration": "A String", # Duration the execution spent executing.
+ "processType": "A String", # The executions type.
},
],
+ "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages
+ # remaining.
}</pre>
</div>
<div class="method">
- <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>
- <pre>List information about a script's executed processes, such as process type
+ <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>
+ <pre>List information about a script's executed processes, such as process type
and current status.
Args:
@@ -154,47 +154,47 @@
started on or after the given timestamp.
pageSize: integer, The maximum number of returned processes per page of results. Defaults to
50.
- scriptProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
-the specified process statuses. (repeated)
+ scriptProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
+a script function with the given function name.
+ scriptId: string, The script ID of the project whose processes are listed.
+ scriptProcessFilter_types: string, Optional field used to limit returned processes to those having one of
+the specified process types. (repeated)
scriptProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
the specified user access levels. (repeated)
+ scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
+projects with a specific deployment ID.
+ scriptProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of
+the specified process statuses. (repeated)
+ scriptProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
+on or before the given timestamp.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- 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.
- scriptId: string, The script ID of the project whose processes are listed.
- scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
-projects with a specific deployment ID.
- scriptProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
-on or before the given timestamp.
- scriptProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
-a script function with the given function name.
- scriptProcessFilter_types: string, Optional field used to limit returned processes to those having one of
-the specified process types. (repeated)
Returns:
An object of the form:
{ # Response with the list of
# Process resources.
- "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages
- # remaining.
- "processes": [ # List of processes matching request parameters.
+ "processes": [ # List of processes matching request parameters.
{ # 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.
- "processStatus": "A String", # The executions status.
- "userAccessLevel": "A String", # The executing users access level to the script.
- "functionName": "A String", # Name of the function the started the execution.
- "projectName": "A String", # Name of the script being executed.
- "startTime": "A String", # Time the execution started.
- "duration": "A String", # Duration the execution spent executing.
- "processType": "A String", # The executions type.
+ "processStatus": "A String", # The executions status.
+ "userAccessLevel": "A String", # The executing users access level to the script.
+ "projectName": "A String", # Name of the script being executed.
+ "startTime": "A String", # Time the execution started.
+ "functionName": "A String", # Name of the function the started the execution.
+ "duration": "A String", # Duration the execution spent executing.
+ "processType": "A String", # The executions type.
},
],
+ "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages
+ # remaining.
}</pre>
</div>
@@ -207,7 +207,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -221,7 +221,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>