chore: regens API reference docs (#889)
diff --git a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html
index 80cfcd4..694a9c7 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.scanRuns.html
@@ -107,8 +107,7 @@
<pre>Gets a ScanRun.
Args:
- name: string, Required.
-The resource name of the ScanRun to be returned. The name follows the
+ 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.
@@ -120,35 +119,26 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "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.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
}</pre>
</div>
@@ -158,8 +148,7 @@
stop time.
Args:
- parent: string, Required.
-The parent resource name, which should be a scan resource name in the
+ 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
@@ -180,35 +169,26 @@
# 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.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "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.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
},
],
}</pre>
@@ -233,8 +213,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
+ 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.
@@ -252,35 +231,26 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan.
- "name": "A String", # Output only.
- # The resource name of the ScanRun. The name follows the format of
+ "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.
- "executionState": "A String", # Output only.
- # The execution state of the ScanRun.
- "urlsTestedCount": "A String", # Output only.
- # The number of URLs tested during this ScanRun. If the scan is in progress,
+ "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.
- "progressPercent": 42, # Output only.
- # The percentage of total completion ranging from 0 to 100.
+ "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.
- "resultState": "A String", # Output only.
- # The result state of the ScanRun. This field is only available after the
- # execution state reaches "FINISHED".
- "startTime": "A String", # Output only.
- # The time at which the ScanRun started.
- "endTime": "A String", # Output only.
- # The time at which the ScanRun reached termination state - that the ScanRun
- # is either finished or stopped by user.
- "hasVulnerabilities": True or False, # Output only.
- # Whether the scan run has found any vulnerabilities.
- "urlsCrawledCount": "A String", # Output only.
- # The number of URLs crawled during this ScanRun. If the scan is in progress,
+ "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.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
}</pre>
</div>