docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
index 0cff744..5469f69 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.scanRuns.html
@@ -90,11 +90,14 @@
<p class="firstline">Returns the findings Resource.</p>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a ScanRun.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun</p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
@@ -103,13 +106,16 @@
<p class="firstline">Stops a ScanRun. The stopped ScanRun is returned.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a ScanRun.
Args:
- name: string, Required. The resource name of the ScanRun to be returned. The name follows the
-format of
-'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
+ name: string, Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -118,72 +124,40 @@
Returns:
An object of the form:
- { # A ScanRun is a output-only resource representing an actual run of the scan.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "code": "A String", # Indicates the error reason code.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
- # troubleshooting purposes only and its actual value can change in the
- # future.
- "code": "A String", # Indicates the reason code for a configuration failure.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "name": "A String", # The resource name of the ScanRun. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
- # The ScanRun IDs are generated by the system.
+ { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Indicates the warning code.
},
],
- "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
- # If the scan is in queue, the value is 0.
- # If the scan is running, the value ranges from 0 to 100.
- # If the scan is finished, the value is 100.
"executionState": "A String", # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
- <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
-stop time.
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <pre>Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Args:
- parent: string, Required. The parent resource name, which should be a scan resource name in the
-format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
- pageSize: integer, The maximum number of ScanRuns to return, can be limited by server.
-If not specified or not positive, the implementation will select a
-reasonable value.
- pageToken: string, A token identifying a page of results to be returned. This should be a
-`next_page_token` value returned from a previous List request.
-If unspecified, the first page of results is returned.
+ parent: string, Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+ pageToken: string, A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
+ pageSize: integer, The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -193,60 +167,33 @@
An object of the form:
{ # Response for the `ListScanRuns` method.
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"scanRuns": [ # The list of ScanRuns returned.
- { # A ScanRun is a output-only resource representing an actual run of the scan.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "code": "A String", # Indicates the error reason code.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
- # troubleshooting purposes only and its actual value can change in the
- # future.
- "code": "A String", # Indicates the reason code for a configuration failure.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "name": "A String", # The resource name of the ScanRun. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
- # The ScanRun IDs are generated by the system.
+ { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Indicates the warning code.
},
],
- "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
- # If the scan is in queue, the value is 0.
- # If the scan is running, the value ranges from 0 to 100.
- # If the scan is finished, the value is 100.
"executionState": "A String", # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
}</pre>
</div>
@@ -269,9 +216,7 @@
<pre>Stops a ScanRun. The stopped ScanRun is returned.
Args:
- name: string, Required. The resource name of the ScanRun to be stopped. The name follows the
-format of
-'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
+ name: string, Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. (required)
body: object, The request body.
The object takes the form of:
@@ -286,55 +231,29 @@
Returns:
An object of the form:
- { # A ScanRun is a output-only resource representing an actual run of the scan.
- # Next id: 12
- "resultState": "A String", # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
- # Defines an error trace message for a ScanRun.
- "code": "A String", # Indicates the error reason code.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
- # message encountered during scan configuration validation that is performed
- # before each scan run.
- # APIs when scan configuration validation fails. It is also reported as part of
- # a ScanRunErrorTrace message if scan validation fails due to a scan
- # configuration error.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
- # troubleshooting purposes only and its actual value can change in the
- # future.
- "code": "A String", # Indicates the reason code for a configuration failure.
- },
- },
- "startTime": "A String", # The time at which the ScanRun started.
- "name": "A String", # The resource name of the ScanRun. The name follows the format of
- # 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
- # The ScanRun IDs are generated by the system.
+ { # A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
"warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
+ { # Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
"code": "A String", # Indicates the warning code.
},
],
- "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
- # If the scan is in queue, the value is 0.
- # If the scan is running, the value ranges from 0 to 100.
- # If the scan is finished, the value is 100.
"executionState": "A String", # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs tested up to now. The number of
- # URLs tested is usually larger than the number URLS crawled because
- # typically a crawled URL is tested with multiple test payloads.
- "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress,
- # the value represents the number of URLs crawled up to now.
"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
+ "urlsTestedCount": "A String", # The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
+ "name": "A String", # The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ "urlsCrawledCount": "A String", # The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
+ "code": "A String", # Indicates the error reason code.
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error. # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
+ },
+ },
}</pre>
</div>