Class ScanConfig (1.9.2)

ScanConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A ScanConfig resource contains the configurations to launch a scan.

Attributes
Name	Description
`name`	`str` The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
`display_name`	`str` Required. The user provided display name of the ScanConfig.
`max_qps`	`int` 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.
`starting_urls`	`Sequence[str]` Required. The starting URLs from which the scanner finds site pages.
`authentication`	`google.cloud.websecurityscanner_v1.types.ScanConfig.Authentication` The authentication configuration. If specified, service will use the authentication configuration during scanning.
`user_agent`	`google.cloud.websecurityscanner_v1.types.ScanConfig.UserAgent` The user agent used during scanning.
`blacklist_patterns`	`Sequence[str]` The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
`schedule`	`google.cloud.websecurityscanner_v1.types.ScanConfig.Schedule` The schedule of the ScanConfig.
`export_to_security_command_center`	`google.cloud.websecurityscanner_v1.types.ScanConfig.ExportToSecurityCommandCenter` Controls export of scan configurations and results to Security Command Center.
`risk_level`	`google.cloud.websecurityscanner_v1.types.ScanConfig.RiskLevel` The risk level selected for the scan
`managed_scan`	`bool` Whether the scan config is managed by Web Security Scanner, output only.
`static_ip_scan`	`bool` Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
`ignore_http_status_errors`	`bool` Whether to keep scanning even if most requests return HTTP error codes.

Classes

Authentication

Authentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Scan authentication configuration.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExportToSecurityCommandCenter

ExportToSecurityCommandCenter(value)

Controls export of scan configurations and results to Security Command Center.

RiskLevel

RiskLevel(value)

Scan risk levels supported by Web Security Scanner. LOW impact scanning will minimize requests with the potential to modify data. To achieve the maximum scan coverage, NORMAL risk level is recommended.

Schedule

Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Scan schedule configuration.

UserAgent

UserAgent(value)

Type of user agents used for scanning.