public sealed class ScanConfig : IMessage<ScanConfig>, IEquatable<ScanConfig>, IDeepCloneable<ScanConfig>, IBufferMessage, IMessageReference documentation and code samples for the Web Security Scanner v1 API class ScanConfig.
A ScanConfig resource contains the configurations to launch a scan.
Implements
IMessage<ScanConfig>, IEquatable<ScanConfig>, IDeepCloneable<ScanConfig>, IBufferMessage, IMessageNamespace
Google.Cloud.WebSecurityScanner.V1Assembly
Google.Cloud.WebSecurityScanner.V1.dll
Constructors
ScanConfig()
public ScanConfig()ScanConfig(ScanConfig)
public ScanConfig(ScanConfig other)| Parameter | |
|---|---|
| Name | Description |
other | ScanConfig |
Properties
Authentication
public ScanConfig.Types.Authentication Authentication { get; set; }The authentication configuration. If specified, service will use the authentication configuration during scanning.
| Property Value | |
|---|---|
| Type | Description |
ScanConfig.Types.Authentication | |
BlacklistPatterns
public RepeatedField<string> BlacklistPatterns { get; }The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<String> | |
DisplayName
public string DisplayName { get; set; }Required. The user provided display name of the ScanConfig.
| Property Value | |
|---|---|
| Type | Description |
String | |
ExportToSecurityCommandCenter
public ScanConfig.Types.ExportToSecurityCommandCenter ExportToSecurityCommandCenter { get; set; }Controls export of scan configurations and results to Security Command Center.
| Property Value | |
|---|---|
| Type | Description |
ScanConfig.Types.ExportToSecurityCommandCenter | |
IgnoreHttpStatusErrors
public bool IgnoreHttpStatusErrors { get; set; }Whether to keep scanning even if most requests return HTTP error codes.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
ManagedScan
public bool ManagedScan { get; set; }Whether the scan config is managed by Web Security Scanner, output only.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
MaxQps
public int MaxQps { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Int32 | |
Name
public string Name { get; set; }The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
| Property Value | |
|---|---|
| Type | Description |
String | |
RiskLevel
public ScanConfig.Types.RiskLevel RiskLevel { get; set; }The risk level selected for the scan
| Property Value | |
|---|---|
| Type | Description |
ScanConfig.Types.RiskLevel | |
Schedule
public ScanConfig.Types.Schedule Schedule { get; set; }The schedule of the ScanConfig.
| Property Value | |
|---|---|
| Type | Description |
ScanConfig.Types.Schedule | |
StartingUrls
public RepeatedField<string> StartingUrls { get; }Required. The starting URLs from which the scanner finds site pages.
| Property Value | |
|---|---|
| Type | Description |
RepeatedField<String> | |
StaticIpScan
public bool StaticIpScan { get; set; }Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
UserAgent
public ScanConfig.Types.UserAgent UserAgent { get; set; }The user agent used during scanning.
| Property Value | |
|---|---|
| Type | Description |
ScanConfig.Types.UserAgent | |