docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html
index 4499c16..e7168e8 100644
--- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html
+++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html
@@ -93,7 +93,7 @@
<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, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <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>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -120,33 +120,6 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
- "progressPercent": 42, # Output only. 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", # Output only. The execution state of the ScanRun.
- "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # Output only. The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # Output only. 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, # Output only. Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # Output only. 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.
- "warningTraces": [ # Output only. 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.
- "code": "A String", # Output only. Indicates the warning code.
- },
- ],
- "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # Output only. 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.
"errorTrace": { # Output only. # 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.
@@ -156,34 +129,61 @@
# 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.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
"fieldName": "A String", # Output only. 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", # Output only. Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Output only. Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # Output only. 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.
- "code": "A String", # Output only. Indicates the error reason code.
},
+ "urlsTestedCount": "A String", # Output only. 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", # Output only. 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", # Output only. The time at which the ScanRun started.
+ "progressPercent": 42, # Output only. 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.
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "warningTraces": [ # Output only. 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.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. 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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <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.
Args:
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.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -196,33 +196,6 @@
"scanRuns": [ # The list of ScanRuns returned.
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
- "progressPercent": 42, # Output only. 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", # Output only. The execution state of the ScanRun.
- "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # Output only. The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # Output only. 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, # Output only. Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # Output only. 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.
- "warningTraces": [ # Output only. 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.
- "code": "A String", # Output only. Indicates the warning code.
- },
- ],
- "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # Output only. 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.
"errorTrace": { # Output only. # 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.
@@ -232,17 +205,44 @@
# 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.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
"fieldName": "A String", # Output only. 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", # Output only. Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Output only. Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # Output only. 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.
- "code": "A String", # Output only. Indicates the error reason code.
},
+ "urlsTestedCount": "A String", # Output only. 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", # Output only. 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", # Output only. The time at which the ScanRun started.
+ "progressPercent": 42, # Output only. 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.
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "warningTraces": [ # Output only. 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.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. 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.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
@@ -288,33 +288,6 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
- "progressPercent": 42, # Output only. 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", # Output only. The execution state of the ScanRun.
- "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "startTime": "A String", # Output only. The time at which the ScanRun started.
- "urlsCrawledCount": "A String", # Output only. 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, # Output only. Whether the scan run has found any vulnerabilities.
- "urlsTestedCount": "A String", # Output only. 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.
- "warningTraces": [ # Output only. 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.
- "code": "A String", # Output only. Indicates the warning code.
- },
- ],
- "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "name": "A String", # Output only. 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.
"errorTrace": { # Output only. # 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.
@@ -324,17 +297,44 @@
# 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.
+ "code": "A String", # Output only. Indicates the reason code for a configuration failure.
"fieldName": "A String", # Output only. 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", # Output only. Indicates the reason code for a configuration failure.
},
+ "code": "A String", # Output only. Indicates the error reason code.
"mostCommonHttpErrorCode": 42, # Output only. 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.
- "code": "A String", # Output only. Indicates the error reason code.
},
+ "urlsTestedCount": "A String", # Output only. 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", # Output only. 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", # Output only. The time at which the ScanRun started.
+ "progressPercent": 42, # Output only. 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.
+ "endTime": "A String", # Output only. The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "warningTraces": [ # Output only. 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.
+ "code": "A String", # Output only. Indicates the warning code.
+ },
+ ],
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
+ "resultState": "A String", # Output only. The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "name": "A String", # Output only. 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.
}</pre>
</div>