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_v1beta.projects.scanConfigs.html b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
index e98bb9c..eaa21dd 100644
--- a/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
+++ b/docs/dyn/websecurityscanner_v1beta.projects.scanConfigs.html
@@ -107,117 +107,117 @@
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.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "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.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
- "A String",
+ "A String",
],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "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.
- },
- "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.
- },
- },
- "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
- # If enabled, the scanner will access applications from static IP addresses.
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "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 ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
+ # Command Center.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "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,
+ "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.
- "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.
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
+ "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
+ { # Output only.
+ # Defines a warning trace message for ScanRun. Warning traces provide customers
+ # with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
+ # scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
- "code": "A String", # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
+ # for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ },
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ # common HTTP error code, if such is available. For example, if this code is
+ # 404, the scan has encountered too many NOT_FOUND responses.
+ "code": "A String", # Indicates the error reason code.
+ },
+ "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.
+ },
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "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.
+ },
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
+ # If enabled, the scanner will access applications from static IP addresses.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
+ # Identity-Aware-Proxy(IAP).
},
},
- "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".
},
+ "riskLevel": "A String", # The risk level selected for the scan
+ "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
+ # only.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -229,112 +229,112 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "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.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
- "A String",
+ "A String",
],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "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.
- },
- "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.
- },
- },
- "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
- # If enabled, the scanner will access applications from static IP addresses.
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "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 ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
+ # Command Center.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "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,
+ "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.
- "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.
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
+ "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
+ { # Output only.
+ # Defines a warning trace message for ScanRun. Warning traces provide customers
+ # with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
+ # scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
- "code": "A String", # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
+ # for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ },
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ # common HTTP error code, if such is available. For example, if this code is
+ # 404, the scan has encountered too many NOT_FOUND responses.
+ "code": "A String", # Indicates the error reason code.
+ },
+ "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.
+ },
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "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.
+ },
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
+ # If enabled, the scanner will access applications from static IP addresses.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
+ # Identity-Aware-Proxy(IAP).
},
},
- "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".
},
+ "riskLevel": "A String", # The risk level selected for the scan
+ "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
+ # only.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}</pre>
</div>
@@ -344,7 +344,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
@@ -371,7 +371,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
@@ -381,112 +381,112 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "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.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
- "A String",
+ "A String",
],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "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.
- },
- "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.
- },
- },
- "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
- # If enabled, the scanner will access applications from static IP addresses.
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "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 ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
+ # Command Center.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "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,
+ "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.
- "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.
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
+ "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
+ { # Output only.
+ # Defines a warning trace message for ScanRun. Warning traces provide customers
+ # with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
+ # scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
- "code": "A String", # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
+ # for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ },
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ # common HTTP error code, if such is available. For example, if this code is
+ # 404, the scan has encountered too many NOT_FOUND responses.
+ "code": "A String", # Indicates the error reason code.
+ },
+ "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.
+ },
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "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.
+ },
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
+ # If enabled, the scanner will access applications from static IP addresses.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
+ # Identity-Aware-Proxy(IAP).
},
},
- "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".
},
+ "riskLevel": "A String", # The risk level selected for the scan
+ "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
+ # only.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}</pre>
</div>
@@ -496,7 +496,7 @@
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)
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.
@@ -512,118 +512,118 @@
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.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "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.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
- "A String",
+ "A String",
],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "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.
- },
- "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.
- },
- },
- "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
- # If enabled, the scanner will access applications from static IP addresses.
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "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 ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
+ # Command Center.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "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,
+ "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.
- "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.
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
+ "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
+ { # Output only.
+ # Defines a warning trace message for ScanRun. Warning traces provide customers
+ # with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
+ # scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
- "code": "A String", # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
+ # for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ },
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ # common HTTP error code, if such is available. For example, if this code is
+ # 404, the scan has encountered too many NOT_FOUND responses.
+ "code": "A String", # Indicates the error reason code.
+ },
+ "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.
+ },
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "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.
+ },
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
+ # If enabled, the scanner will access applications from static IP addresses.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
+ # Identity-Aware-Proxy(IAP).
},
},
- "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".
},
+ "riskLevel": "A String", # The risk level selected for the scan
+ "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
+ # only.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
},
],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
+ # more results in the list.
}</pre>
</div>
@@ -636,7 +636,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>
@@ -647,118 +647,118 @@
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.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "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.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
- "A String",
+ "A String",
],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "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.
- },
- "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.
- },
- },
- "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
- # If enabled, the scanner will access applications from static IP addresses.
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "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 ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
+ # Command Center.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "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,
+ "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.
- "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.
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
+ "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
+ { # Output only.
+ # Defines a warning trace message for ScanRun. Warning traces provide customers
+ # with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
+ # scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
- "code": "A String", # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
+ # for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ },
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ # common HTTP error code, if such is available. For example, if this code is
+ # 404, the scan has encountered too many NOT_FOUND responses.
+ "code": "A String", # Indicates the error reason code.
+ },
+ "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.
+ },
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "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.
+ },
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
+ # If enabled, the scanner will access applications from static IP addresses.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
+ # Identity-Aware-Proxy(IAP).
},
},
- "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".
},
+ "riskLevel": "A String", # The risk level selected for the scan
+ "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
+ # only.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}
updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition,
@@ -773,112 +773,112 @@
An object of the form:
{ # A ScanConfig resource contains the configurations to launch a scan.
- "blacklistPatterns": [ # The blacklist URL patterns as described in
- # https://cloud.google.com/security-scanner/docs/excluded-urls
- "A String",
- ],
- "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.
- },
- "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
- # Command Center.
- "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
+ "targetPlatforms": [ # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
# used as a default.
- "A String",
+ "A String",
],
- "riskLevel": "A String", # The risk level selected for the scan
- "authentication": { # Scan authentication configuration. # The authentication configuration. If specified, service will use the
- # authentication configuration during scanning.
- "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
- "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
- # account is added in Identity-Aware-Proxy (IAP) access policies.
- # service account is added in Identity-Aware-Proxy (IAP) access policies.
- "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
- # Identity-Aware-Proxy(IAP).
- },
- },
- "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.
- },
- "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.
- },
- },
- "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
- # If enabled, the scanner will access applications from static IP addresses.
- "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
- # only.
- "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 ScanConfig. The name follows the format of
+ # 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are
+ # generated by the system.
+ "exportToSecurityCommandCenter": "A String", # Controls export of scan configurations and results to Cloud Security
+ # Command Center.
+ "latestRun": { # A ScanRun is a output-only resource representing an actual run of the scan. # Latest ScanRun if available.
# Next id: 12
- "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "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,
+ "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.
- "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.
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
+ "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
+ { # Output only.
+ # Defines a warning trace message for ScanRun. Warning traces provide customers
+ # with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
+ # scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
- "code": "A String", # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
+ # for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
+ "code": "A String", # Indicates the reason code for a configuration failure.
+ },
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ # common HTTP error code, if such is available. For example, if this code is
+ # 404, the scan has encountered too many NOT_FOUND responses.
+ "code": "A String", # Indicates the error reason code.
+ },
+ "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.
+ },
+ "displayName": "A String", # Required. The user provided display name of the ScanConfig.
+ "userAgent": "A String", # The user agent used during scanning.
+ "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.
+ },
+ "staticIpScan": True or False, # Whether the scan configuration has enabled static IP address scan feature.
+ # If enabled, the scanner will access applications from static IP addresses.
+ "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.
+ "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.
+ "username": "A String", # Required. The user name of the custom account.
+ },
+ "iapCredential": { # Describes authentication configuration for Identity-Aware-Proxy (IAP). # Authentication using Identity-Aware-Proxy (IAP).
+ "iapTestServiceAccountInfo": { # Describes authentication configuration when Web-Security-Scanner # Authentication configuration when Web-Security-Scanner service
+ # account is added in Identity-Aware-Proxy (IAP) access policies.
+ # service account is added in Identity-Aware-Proxy (IAP) access policies.
+ "targetAudienceClientId": "A String", # Required. Describes OAuth2 Client ID of resources protected by
+ # Identity-Aware-Proxy(IAP).
},
},
- "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".
},
+ "riskLevel": "A String", # The risk level selected for the scan
+ "managedScan": True or False, # Whether the scan config is managed by Cloud Web Security Scanner, output
+ # only.
+ "blacklistPatterns": [ # The blacklist URL patterns as described in
+ # https://cloud.google.com/security-scanner/docs/excluded-urls
+ "A String",
+ ],
+ "startingUrls": [ # Required. The starting URLs from which the scanner finds site pages.
+ "A String",
+ ],
}</pre>
</div>
@@ -888,7 +888,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:
@@ -905,53 +905,53 @@
{ # A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
- "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
- { # Output only.
- # Defines a warning trace message for ScanRun. Warning traces provide customers
- # with useful information that helps make the scanning process more effective.
- "code": "A String", # Indicates the warning code.
- },
- ],
- "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,
+ "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.
- "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.
- "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
- # scan's termination and more details, if such are available.
+ "warningTraces": [ # A list of warnings, if such are encountered during this scan run.
+ { # Output only.
+ # Defines a warning trace message for ScanRun. Warning traces provide customers
+ # with useful information that helps make the scanning process more effective.
+ "code": "A String", # Indicates the warning code.
+ },
+ ],
+ "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.
+ "errorTrace": { # Output only. # If result_state is an ERROR, this field provides the primary reason for
+ # scan's termination and more details, if such are available.
# Defines an error trace message for a ScanRun.
- "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
- # common HTTP error code, if such is available. For example, if this code is
- # 404, the scan has encountered too many NOT_FOUND responses.
- "code": "A String", # Indicates the error reason code.
- "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
+ "scanConfigError": { # Defines a custom error message used by CreateScanConfig and UpdateScanConfig # If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error
# message encountered during scan configuration validation that is performed
# before each scan run.
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
- "code": "A String", # Indicates the reason code for a configuration failure.
- "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
- # for example "scan_config.max_qps". This field is provided for
+ "fieldName": "A String", # Indicates the full name of the ScanConfig field that triggers this error,
+ # for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
+ "code": "A String", # Indicates the reason code for a configuration failure.
},
+ "mostCommonHttpErrorCode": 42, # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most
+ # common HTTP error code, if such is available. For example, if this code is
+ # 404, the scan has encountered too many NOT_FOUND responses.
+ "code": "A String", # Indicates the error reason code.
},
- "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".
+ "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.
}</pre>
</div>