Class ScanConfig
A ScanConfig resource contains the configurations to launch a scan. next id: 12
Implements
Inherited Members
Namespace: Google.Apis.WebSecurityScanner.v1alpha.Data
Assembly: Google.Apis.WebSecurityScanner.v1alpha.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 excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls
Declaration
[JsonProperty("blacklistPatterns")]
public virtual IList<string> BlacklistPatterns { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
DisplayName
Required. The user provided display name of the ScanConfig.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
LatestRun
Latest ScanRun if available.
Declaration
[JsonProperty("latestRun")]
public virtual ScanRun LatestRun { get; set; }
Property Value
Type | Description |
---|---|
ScanRun |
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 |
---|---|
int? |
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 |
---|---|
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 |
---|---|
IList<string> |
TargetPlatforms
Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
Declaration
[JsonProperty("targetPlatforms")]
public virtual IList<string> TargetPlatforms { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
UserAgent
The user agent used during scanning.
Declaration
[JsonProperty("userAgent")]
public virtual string UserAgent { get; set; }
Property Value
Type | Description |
---|---|
string |