docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
index 023997d..d4f8db0 100644
--- a/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1alpha.projects.scanConfigs.html
@@ -89,7 +89,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, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=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>
@@ -107,76 +107,76 @@
Args:
parent: string, Required. The parent resource name where the scan is created, which should be a
-project resource name in the format 'projects/{projectId}'. (required)
+project resource name in the format 'projects/{projectId}'. (required)
body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- # next id: 12
- "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.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "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.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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 Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
+ # next id: 12
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "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.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
},
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "userAgent": "A String", # The user agent used during scanning.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "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.
},
- },
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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", # 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, # 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.
- "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".
- },
-}
+ "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.
+ "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.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
+ # and not returned in any response nor included in audit logs.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ },
+ }
x__xgafv: string, V1 error format.
Allowed values
@@ -187,71 +187,71 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- # next id: 12
- "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.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "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.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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 Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
+ # next id: 12
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "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.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
},
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "userAgent": "A String", # The user agent used during scanning.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "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.
},
- },
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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", # 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, # 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.
- "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>
+ "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.
+ "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.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
+ # and not returned in any response nor included in audit logs.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ },
+ }</pre>
</div>
<div class="method">
@@ -260,7 +260,7 @@
Args:
name: string, Required. The resource name of the ScanConfig to be deleted. The name follows the
-format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -287,7 +287,7 @@
Args:
name: string, Required. The resource name of the ScanConfig to be returned. The name follows the
-format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -297,165 +297,165 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- # next id: 12
- "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.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "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.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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 Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
+ # next id: 12
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "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.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
},
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "userAgent": "A String", # The user agent used during scanning.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "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.
},
- },
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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", # 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, # 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.
- "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>
+ "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.
+ "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.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
+ # and not returned in any response nor included in audit logs.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ },
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=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)
+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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- 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.
Returns:
An object of the form:
{ # Response for the `ListScanConfigs` method.
- "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
- # more results in the list.
- "scanConfigs": [ # The list of ScanConfigs returned.
+ "scanConfigs": [ # The list of ScanConfigs returned.
{ # A ScanConfig resource contains the configurations to launch a scan.
- # next id: 12
- "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.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "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.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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 Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
+ # next id: 12
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "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.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
},
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "userAgent": "A String", # The user agent used during scanning.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "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.
+ },
+ "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.
+ "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.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
+ # and not returned in any response nor included in audit logs.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
},
},
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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", # 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, # 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.
- "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".
- },
- },
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
}</pre>
</div>
@@ -468,7 +468,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -479,77 +479,77 @@
Args:
name: string, The resource name of the ScanConfig. The name follows the format of
-'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
generated by the system. (required)
body: object, The request body.
The object takes the form of:
{ # A ScanConfig resource contains the configurations to launch a scan.
- # next id: 12
- "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.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "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.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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 Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
+ # next id: 12
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "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.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
},
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "userAgent": "A String", # The user agent used during scanning.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "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.
},
- },
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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", # 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, # 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.
- "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".
- },
-}
+ "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.
+ "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.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
+ # and not returned in any response nor included in audit logs.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ },
+ }
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,
see
@@ -563,71 +563,71 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- # next id: 12
- "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.
- "displayName": "A String", # Required. The user provided display name of the ScanConfig.
- "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.
- "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
- "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 Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
- # used as a default.
- "A String",
- ],
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
- "username": "A String", # Required. The user name of the Google account.
- "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
- # and not returned in any response nor included in audit logs.
+ # next id: 12
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
+ "progressPercent": 42, # The percentage of total completion ranging from 0 to 100.
+ # If the scan is in queue, the value is 0.
+ # If the scan is running, the value ranges from 0 to 100.
+ # If the scan is finished, the value is 100.
+ "executionState": "A String", # The execution state of the ScanRun.
+ "endTime": "A String", # The time at which the ScanRun reached termination state - that the ScanRun
+ # is either finished or stopped by user.
+ "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.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
},
- "customAccount": { # Describes authentication configuration that uses a custom account. # Authentication using a custom account.
- "username": "A String", # Required. The user name of the custom account.
- "loginUrl": "A String", # Required. The login form URL of the website.
- "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.
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
+ "userAgent": "A String", # The user agent used during scanning.
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ # used as a default.
+ "A String",
+ ],
+ "schedule": { # Scan schedule configuration. # The schedule of the ScanConfig.
+ "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.
},
- },
- "userAgent": "A String", # The user agent used during scanning.
- "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
- "A String",
- ],
- "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
- "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", # 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, # 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.
- "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>
+ "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.
+ "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.
+ "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
+ # authentication configuration during scanning.
+ "googleAccount": { # Describes authentication configuration that uses a Google account. # Authentication using a Google account.
+ "password": "A String", # Required. Input only. The password of the Google account. The credential is stored encrypted
+ # and not returned in any response nor included in audit logs.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ "loginUrl": "A String", # Required. The login form URL of the website.
+ },
+ },
+ }</pre>
</div>
<div class="method">
@@ -636,7 +636,7 @@
Args:
name: string, Required. The resource name of the ScanConfig to be used. The name follows the
-format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
+format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. (required)
body: object, The request body.
The object takes the form of:
@@ -652,26 +652,26 @@
An object of the form:
{ # A ScanRun is a output-only resource representing an actual run of the scan.
- "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", # 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, # 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.
- "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
+ "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.
- "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".
+ "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.
+ "hasVulnerabilities": True or False, # Whether the scan run has found any vulnerabilities.
+ "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.
+ "resultState": "A String", # The result state of the ScanRun. This field is only available after the
+ # execution state reaches "FINISHED".
+ "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.
}</pre>
</div>