docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/script_v1.processes.html b/docs/dyn/script_v1.processes.html
index c4bb1b6..d107616 100644
--- a/docs/dyn/script_v1.processes.html
+++ b/docs/dyn/script_v1.processes.html
@@ -75,11 +75,14 @@
<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_deploymentId=None, userProcessFilter_projectName=None, userProcessFilter_userAccessLevels=None, pageSize=None, userProcessFilter_endTime=None, userProcessFilter_functionName=None, userProcessFilter_statuses=None, userProcessFilter_types=None, userProcessFilter_startTime=None, pageToken=None, userProcessFilter_scriptId=None, x__xgafv=None)</a></code></p>
-<p class="firstline">List information about processes made by or on behalf of a user,</p>
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
- <code><a href="#listScriptProcesses">listScriptProcesses(scriptProcessFilter_deploymentId=None, scriptProcessFilter_userAccessLevels=None, scriptProcessFilter_functionName=None, pageToken=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_types=None, scriptId=None, scriptProcessFilter_endTime=None, scriptProcessFilter_startTime=None, x__xgafv=None)</a></code></p>
-<p class="firstline">List information about a script's executed processes, such as process type</p>
+ <code><a href="#list">list(pageToken=None, userProcessFilter_functionName=None, pageSize=None, userProcessFilter_statuses=None, userProcessFilter_deploymentId=None, userProcessFilter_scriptId=None, userProcessFilter_userAccessLevels=None, userProcessFilter_types=None, userProcessFilter_endTime=None, userProcessFilter_startTime=None, userProcessFilter_projectName=None, x__xgafv=None)</a></code></p>
+<p class="firstline">List information about processes made by or on behalf of a user, such as process type and current status.</p>
+<p class="toc_element">
+ <code><a href="#listScriptProcesses">listScriptProcesses(pageToken=None, scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_types=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_userAccessLevels=None, scriptId=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_startTime=None, x__xgafv=None)</a></code></p>
+<p class="firstline">List information about a script's executed processes, such as process type and current status.</p>
<p class="toc_element">
<code><a href="#listScriptProcesses_next">listScriptProcesses_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -88,33 +91,53 @@
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="list">list(userProcessFilter_deploymentId=None, userProcessFilter_projectName=None, userProcessFilter_userAccessLevels=None, pageSize=None, userProcessFilter_endTime=None, userProcessFilter_functionName=None, userProcessFilter_statuses=None, userProcessFilter_types=None, userProcessFilter_startTime=None, pageToken=None, userProcessFilter_scriptId=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.
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(pageToken=None, userProcessFilter_functionName=None, pageSize=None, userProcessFilter_statuses=None, userProcessFilter_deploymentId=None, userProcessFilter_scriptId=None, userProcessFilter_userAccessLevels=None, userProcessFilter_types=None, userProcessFilter_endTime=None, userProcessFilter_startTime=None, userProcessFilter_projectName=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_deploymentId: string, Optional field used to limit returned processes to those originating from
-projects with a specific deployment ID.
- userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from
-projects with project names containing a specific string.
- userProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
-the specified user access levels. (repeated)
- pageSize: integer, The maximum number of returned processes per page of results. Defaults to
-50.
- 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_statuses: string, Optional field used to limit returned processes to those having one of
-the specified process statuses. (repeated)
- userProcessFilter_types: string, Optional field used to limit returned processes to those having one of
-the specified process types. (repeated)
- userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
-started on or after 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.
- userProcessFilter_scriptId: string, Optional field used to limit returned processes to those originating from
-projects with a specific script ID.
+ 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_functionName: string, Optional field used to limit returned processes to those originating from a script function with the given function name.
+ pageSize: integer, The maximum number of returned processes per page of results. Defaults to 50.
+ userProcessFilter_statuses: string, Optional field used to limit returned processes to those having one of the specified process statuses. (repeated)
+ Allowed values
+ PROCESS_STATUS_UNSPECIFIED - Unspecified status.
+ RUNNING - The process is currently running.
+ PAUSED - The process has paused.
+ COMPLETED - The process has completed.
+ CANCELED - The process was cancelled.
+ FAILED - The process failed.
+ TIMED_OUT - The process timed out.
+ UNKNOWN - Process status unknown.
+ DELAYED - The process is delayed, waiting for quota.
+ 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_userAccessLevels: string, Optional field used to limit returned processes to those having one of the specified user access levels. (repeated)
+ Allowed values
+ USER_ACCESS_LEVEL_UNSPECIFIED - User access level unspecified
+ NONE - The user has no access.
+ READ - The user has read-only access.
+ WRITE - The user has write access.
+ OWNER - The user is an owner.
+ userProcessFilter_types: string, Optional field used to limit returned processes to those having one of the specified process types. (repeated)
+ Allowed values
+ PROCESS_TYPE_UNSPECIFIED - Unspecified type.
+ ADD_ON - The process was started from an add-on entry point.
+ EXECUTION_API - The process was started using the Apps Script API.
+ TIME_DRIVEN - The process was started from a time-based trigger.
+ TRIGGER - The process was started from an event-based trigger.
+ WEBAPP - The process was started from a web app entry point.
+ EDITOR - The process was started using the Apps Script IDE.
+ SIMPLE_TRIGGER - The process was started from a G Suite simple trigger.
+ MENU - The process was started from a G Suite menu item.
+ BATCH_TASK - The process was started as a task in a batch job.
+ userProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed on or before the given timestamp.
+ userProcessFilter_startTime: string, Optional field used to limit returned processes to those that were started on or after the given timestamp.
+ userProcessFilter_projectName: string, Optional field used to limit returned processes to those originating from projects with project names containing a specific string.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -123,52 +146,64 @@
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.
+ { # Response with the list of Process resources.
"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.
+ { # 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.
"startTime": "A String", # Time the execution started.
"functionName": "A String", # Name of the function the started the execution.
- "userAccessLevel": "A String", # The executing users access level to the script.
- "processStatus": "A String", # The executions status.
- "processType": "A String", # The executions type.
- "duration": "A String", # Duration the execution spent executing.
"projectName": "A String", # Name of the script being executed.
+ "processType": "A String", # The executions type.
+ "processStatus": "A String", # The executions status.
+ "duration": "A String", # Duration the execution spent executing.
+ "userAccessLevel": "A String", # The executing users access level to the script.
},
],
+ "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_deploymentId=None, scriptProcessFilter_userAccessLevels=None, scriptProcessFilter_functionName=None, pageToken=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_types=None, scriptId=None, scriptProcessFilter_endTime=None, scriptProcessFilter_startTime=None, x__xgafv=None)</code>
- <pre>List information about a script's executed processes, such as process type
-and current status.
+ <code class="details" id="listScriptProcesses">listScriptProcesses(pageToken=None, scriptProcessFilter_endTime=None, scriptProcessFilter_functionName=None, scriptProcessFilter_types=None, pageSize=None, scriptProcessFilter_statuses=None, scriptProcessFilter_userAccessLevels=None, scriptId=None, scriptProcessFilter_deploymentId=None, scriptProcessFilter_startTime=None, x__xgafv=None)</code>
+ <pre>List information about a script's executed processes, such as process type and current status.
Args:
- scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from
-projects with a specific deployment ID.
- scriptProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of
-the specified user access levels. (repeated)
- scriptProcessFilter_functionName: string, Optional field used to limit returned processes to those originating from
-a script function with the given function name.
- 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.
- 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_types: string, Optional field used to limit returned processes to those having one of
-the specified process types. (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.
+ 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)
+ Allowed values
+ PROCESS_TYPE_UNSPECIFIED - Unspecified type.
+ ADD_ON - The process was started from an add-on entry point.
+ EXECUTION_API - The process was started using the Apps Script API.
+ TIME_DRIVEN - The process was started from a time-based trigger.
+ TRIGGER - The process was started from an event-based trigger.
+ WEBAPP - The process was started from a web app entry point.
+ EDITOR - The process was started using the Apps Script IDE.
+ SIMPLE_TRIGGER - The process was started from a G Suite simple trigger.
+ MENU - The process was started from a G Suite menu item.
+ BATCH_TASK - The process was started as a task in a batch job.
+ 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)
+ Allowed values
+ PROCESS_STATUS_UNSPECIFIED - Unspecified status.
+ RUNNING - The process is currently running.
+ PAUSED - The process has paused.
+ COMPLETED - The process has completed.
+ CANCELED - The process was cancelled.
+ FAILED - The process failed.
+ TIMED_OUT - The process timed out.
+ UNKNOWN - Process status unknown.
+ DELAYED - The process is delayed, waiting for quota.
+ scriptProcessFilter_userAccessLevels: string, Optional field used to limit returned processes to those having one of the specified user access levels. (repeated)
+ Allowed values
+ USER_ACCESS_LEVEL_UNSPECIFIED - User access level unspecified
+ NONE - The user has no access.
+ READ - The user has read-only access.
+ WRITE - The user has write access.
+ OWNER - The user is an owner.
scriptId: string, The script ID of the project whose processes are listed.
- scriptProcessFilter_endTime: string, Optional field used to limit returned processes to those that completed
-on or before the given timestamp.
- scriptProcessFilter_startTime: string, Optional field used to limit returned processes to those that were
-started on or after the given timestamp.
+ scriptProcessFilter_deploymentId: string, Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
+ scriptProcessFilter_startTime: string, Optional field used to limit returned processes to those that were started on or after the given timestamp.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -177,24 +212,19 @@
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.
+ { # Response with the list of Process resources.
"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.
+ { # 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.
"startTime": "A String", # Time the execution started.
"functionName": "A String", # Name of the function the started the execution.
- "userAccessLevel": "A String", # The executing users access level to the script.
- "processStatus": "A String", # The executions status.
- "processType": "A String", # The executions type.
- "duration": "A String", # Duration the execution spent executing.
"projectName": "A String", # Name of the script being executed.
+ "processType": "A String", # The executions type.
+ "processStatus": "A String", # The executions status.
+ "duration": "A String", # Duration the execution spent executing.
+ "userAccessLevel": "A String", # The executing users access level to the script.
},
],
+ "nextPageToken": "A String", # Token for the next page of results. If empty, there are no more pages remaining.
}</pre>
</div>