Class ScanConfig
A ScanConfig resource contains the configurations to launch a scan.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.WebSecurityScanner.v1.Data
Assembly: Google.Apis.WebSecurityScanner.v1.dll
Syntax
public class ScanConfig : IDirectResponseSchema
Properties
Authentication
The authentication configuration. If specified, service will use the authentication configuration during scanning.
Declaration
[JsonProperty("authentication")]
public virtual Authentication Authentication { get; set; }
Property Value
| Type | Description |
|---|---|
| Authentication |
BlacklistPatterns
The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded- urls
Declaration
[JsonProperty("blacklistPatterns")]
public virtual IList<string> BlacklistPatterns { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
DisplayName
Required. The user provided display name of the ScanConfig.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ExportToSecurityCommandCenter
Controls export of scan configurations and results to Cloud Security Command Center.
Declaration
[JsonProperty("exportToSecurityCommandCenter")]
public virtual string ExportToSecurityCommandCenter { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
ManagedScan
Whether the scan config is managed by Cloud Web Security Scanner, output only.
Declaration
[JsonProperty("managedScan")]
public virtual bool? ManagedScan { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
MaxQps
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.
Declaration
[JsonProperty("maxQps")]
public virtual int? MaxQps { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Name
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
RiskLevel
The risk level selected for the scan
Declaration
[JsonProperty("riskLevel")]
public virtual string RiskLevel { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Schedule
The schedule of the ScanConfig.
Declaration
[JsonProperty("schedule")]
public virtual Schedule Schedule { get; set; }
Property Value
| Type | Description |
|---|---|
| Schedule |
StartingUrls
Required. The starting URLs from which the scanner finds site pages.
Declaration
[JsonProperty("startingUrls")]
public virtual IList<string> StartingUrls { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<System.String> |
StaticIpScan
Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses.
Declaration
[JsonProperty("staticIpScan")]
public virtual bool? StaticIpScan { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
UserAgent
The user agent used during scanning.
Declaration
[JsonProperty("userAgent")]
public virtual string UserAgent { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |