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_v1alpha.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
index 5c814f7..45846f9 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
@@ -92,7 +92,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a ScanConfig.</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 ScanConfigs under a given project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,26 +119,13 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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".
- "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.
- "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.
- },
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
@@ -147,17 +134,30 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
"username": "A String", # Required. The user name of the custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
},
},
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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".
+ "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.
+ "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.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "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.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -169,26 +169,13 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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".
- "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.
- "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.
- },
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
@@ -197,17 +184,30 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
"username": "A String", # Required. The user name of the custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
},
},
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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".
+ "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.
+ "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.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "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.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
}</pre>
</div>
@@ -244,26 +244,13 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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".
- "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.
- "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.
- },
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
@@ -272,28 +259,41 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
"username": "A String", # Required. The user name of the custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
},
},
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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".
+ "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.
+ "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.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "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.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
}</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 ScanConfigs under a given project.
Args:
parent: string, Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. (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 ScanConfigs 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
@@ -305,26 +305,13 @@
{ # Response for the `ListScanConfigs` method.
"scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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".
- "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.
- "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.
- },
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
@@ -333,17 +320,30 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
"username": "A String", # Required. The user name of the custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
},
},
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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".
+ "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.
+ "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.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "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.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
@@ -374,26 +374,13 @@
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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".
- "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.
- "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.
- },
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
@@ -402,17 +389,30 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
"username": "A String", # Required. The user name of the custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
},
},
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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".
+ "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.
+ "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.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "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.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
@@ -425,26 +425,13 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan. next id: 12
- "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
- "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.
- "executionState": "A String", # The execution state of the ScanRun.
- "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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".
- "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.
- "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.
- },
+ "userAgent": "A String", # The user agent used during scanning.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
"schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "intervalDurationDays": 42, # Required. The duration of time between executions in days.
"scheduleTime": "A String", # A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
+ "intervalDurationDays": 42, # Required. The duration of time between executions in days.
},
- "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
"A String",
],
"authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the authentication configuration during scanning.
@@ -453,17 +440,30 @@
"username": "A String", # Required. The user name of the Google account.
},
"customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
"username": "A String", # Required. The user name of the custom account.
"password": "A String", # Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
- "loginUrl": "A String", # Required. The login form URL of the website.
},
},
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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".
+ "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.
+ "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.
+ "startTime": "A String", # The time at which the ScanRun started.
+ "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.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
+ },
+ "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "name": "A String", # The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
+ "targetPlatforms": [ # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
"A String",
],
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "userAgent": "A String", # The user agent used during scanning.
- "maxQps": 42, # The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
+ "blacklistPatterns": [ # The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
+ "A String",
+ ],
}</pre>
</div>
@@ -489,14 +489,14 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
"hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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".
+ "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.
+ "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.
+ "startTime": "A String", # The time at which the ScanRun started.
"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.
"executionState": "A String", # The execution state of the ScanRun.
"endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
- "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".
- "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.
- "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.
}</pre>
</div>