GoogleApi.WebSecurityScanner.V1.Model.ScanConfig (google_api_web_security_scanner v0.19.0)
View SourceA ScanConfig resource contains the configurations to launch a scan.
Attributes
-
authentication
(type:GoogleApi.WebSecurityScanner.V1.Model.Authentication.t
, default:nil
) - The authentication configuration. If specified, service will use the authentication configuration during scanning. -
blacklistPatterns
(type:list(String.t)
, default:nil
) - The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls -
displayName
(type:String.t
, default:nil
) - Required. The user provided display name of the ScanConfig. -
exportToSecurityCommandCenter
(type:String.t
, default:nil
) - Controls export of scan configurations and results to Security Command Center. -
ignoreHttpStatusErrors
(type:boolean()
, default:nil
) - Whether to keep scanning even if most requests return HTTP error codes. -
latestRun
(type:GoogleApi.WebSecurityScanner.V1.Model.ScanRun.t
, default:nil
) - -
managedScan
(type:boolean()
, default:nil
) - Whether the scan config is managed by Web Security Scanner, output only. -
maxQps
(type:integer()
, default:nil
) - 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. -
name
(type:String.t
, default:nil
) - Identifier. The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. -
riskLevel
(type:String.t
, default:nil
) - The risk level selected for the scan -
schedule
(type:GoogleApi.WebSecurityScanner.V1.Model.Schedule.t
, default:nil
) - The schedule of the ScanConfig. -
startingUrls
(type:list(String.t)
, default:nil
) - Required. The starting URLs from which the scanner finds site pages. -
staticIpScan
(type:boolean()
, default:nil
) - Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. -
targetPlatforms
(type:list(String.t)
, default:nil
) - Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. -
userAgent
(type:String.t
, default:nil
) - The user agent used during scanning.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.WebSecurityScanner.V1.Model.ScanConfig{ authentication: GoogleApi.WebSecurityScanner.V1.Model.Authentication.t() | nil, blacklistPatterns: [String.t()] | nil, displayName: String.t() | nil, exportToSecurityCommandCenter: String.t() | nil, ignoreHttpStatusErrors: boolean() | nil, latestRun: GoogleApi.WebSecurityScanner.V1.Model.ScanRun.t() | nil, managedScan: boolean() | nil, maxQps: integer() | nil, name: String.t() | nil, riskLevel: String.t() | nil, schedule: GoogleApi.WebSecurityScanner.V1.Model.Schedule.t() | nil, startingUrls: [String.t()] | nil, staticIpScan: boolean() | nil, targetPlatforms: [String.t()] | nil, userAgent: String.t() | nil }