chore: update docs/dyn , add static discovery files to discovery_cache/documents (#1111)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/78f53313-0c78-4a29-8841-f031665a4c6a/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html
index eb56e28..828409e 100644
--- a/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html
+++ b/docs/dyn/websecurityscanner_v1.projects.scanConfigs.scanRuns.html
@@ -96,7 +96,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, pageSize=None, pageToken=None, x__xgafv=None)</a></code></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>
@@ -125,39 +125,39 @@
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", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "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.
- "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.
- "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.
- "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # 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.
- "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.
- "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. # Output only. 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", # 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.
- },
- },
- "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.
- "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.
- "executionState": "A String", # Output only. The execution state of the ScanRun.
"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.
},
],
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # 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.
+ "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.
+ "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. # Output only. 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", # 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.
+ },
+ },
+ "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.
+ "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.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "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.
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <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.
+ 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
@@ -167,33 +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", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "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.
- "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.
- "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.
- "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # 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.
- "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.
- "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. # Output only. 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", # 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.
- },
- },
- "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.
- "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.
- "executionState": "A String", # Output only. The execution state of the ScanRun.
"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.
},
],
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # 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.
+ "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.
+ "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. # Output only. 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", # 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.
+ },
+ },
+ "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.
+ "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.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "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.
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
},
],
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
@@ -232,28 +232,28 @@
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", # Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
- "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.
- "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.
- "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.
- "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
- "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # 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.
- "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.
- "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. # Output only. 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", # 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.
- },
- },
- "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.
- "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.
- "executionState": "A String", # Output only. The execution state of the ScanRun.
"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.
},
],
+ "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.
+ "errorTrace": { # Output only. Defines an error trace message for a ScanRun. # 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.
+ "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.
+ "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. # Output only. 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", # 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.
+ },
+ },
+ "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.
+ "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.
+ "hasVulnerabilities": True or False, # Output only. Whether the scan run has found any vulnerabilities.
+ "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.
+ "executionState": "A String", # Output only. The execution state of the ScanRun.
}</pre>
</div>