ScanConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)A ScanConfig resource contains the configurations to launch a scan. next id: 12
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_v1alpha.types.ScanConfig.Authentication
The authentication configuration. If specified, service will use the authentication configuration during scanning. |
user_agent |
google.cloud.websecurityscanner_v1alpha.types.ScanConfig.UserAgent
The user agent used during scanning. |
blacklist_patterns |
Sequence[str]
The blacklist URL patterns as described in https://cloud.google.com/security- scanner/docs/excluded-urls |
schedule |
google.cloud.websecurityscanner_v1alpha.types.ScanConfig.Schedule
The schedule of the ScanConfig. |
target_platforms |
Sequence[google.cloud.websecurityscanner_v1alpha.types.ScanConfig.TargetPlatform]
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. |
latest_run |
google.cloud.websecurityscanner_v1alpha.types.ScanRun
Latest ScanRun if available. |
Classes
Authentication
Authentication(mapping=None, *, ignore_unknown_fields=False, **kwargs)Scan authentication configuration. .. attribute:: google_account
Authentication using a Google account.
:type: google.cloud.websecurityscanner_v1alpha.types.ScanConfig.Authentication.GoogleAccount
Schedule
Schedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)Scan schedule configuration. .. attribute:: schedule_time
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.
:type: google.protobuf.timestamp_pb2.Timestamp
TargetPlatform
TargetPlatform(value)Cloud platforms supported by Cloud Web Security Scanner.
UserAgent
UserAgent(value)Type of user agents used for scanning.