Class ScanConfig (1.11.1)

Version 1.11.1

• 1.15.1 (latest)
• 1.15.0
• 1.14.5
• 1.13.0
• 1.12.2
• 1.11.1
• 1.10.0
• 1.9.2
• 1.8.3
• 1.7.2
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.4.2
• 0.3.0

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	MutableSequence[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	MutableSequence[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	MutableSequence[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.

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

Schedule

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

Scan schedule configuration.

TargetPlatform

TargetPlatform(value)

Cloud platforms supported by Cloud Web Security Scanner.

Values: TARGET_PLATFORM_UNSPECIFIED (0): The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error. APP_ENGINE (1): Google App Engine service. COMPUTE (2): Google Compute Engine service.

UserAgent

UserAgent(value)

Type of user agents used for scanning.

Values: USER_AGENT_UNSPECIFIED (0): The user agent is unknown. Service will default to CHROME_LINUX. CHROME_LINUX (1): Chrome on Linux. This is the service default if unspecified. CHROME_ANDROID (2): Chrome on Android. SAFARI_IPHONE (3): Safari on IPhone.