class Google::Apis::WebsecurityscannerV1beta::ScanConfig

A ScanConfig resource contains the configurations to launch a scan.

Attributes

authentication[RW]

Scan authentication configuration. Corresponds to the JSON property `authentication` @return [Google::Apis::WebsecurityscannerV1beta::Authentication]

blacklist_patterns[RW]

The excluded URL patterns as described in cloud.google.com/security- command-center/docs/how-to-use-web-security-scanner#excluding_urls Corresponds to the JSON property `blacklistPatterns` @return [Array<String>]

display_name[RW]

Required. The user provided display name of the ScanConfig. Corresponds to the JSON property `displayName` @return [String]

export_to_security_command_center[RW]

Controls export of scan configurations and results to Security Command Center. Corresponds to the JSON property `exportToSecurityCommandCenter` @return [String]

ignore_http_status_errors[RW]

Whether to keep scanning even if most requests return HTTP error codes. Corresponds to the JSON property `ignoreHttpStatusErrors` @return [Boolean]

ignore_http_status_errors?[RW]

Whether to keep scanning even if most requests return HTTP error codes. Corresponds to the JSON property `ignoreHttpStatusErrors` @return [Boolean]

latest_run[RW]

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12 Corresponds to the JSON property `latestRun` @return [Google::Apis::WebsecurityscannerV1beta::ScanRun]

managed_scan[RW]

Whether the scan config is managed by Web Security Scanner, output only. Corresponds to the JSON property `managedScan` @return [Boolean]

managed_scan?[RW]

Whether the scan config is managed by Web Security Scanner, output only. Corresponds to the JSON property `managedScan` @return [Boolean]

max_qps[RW]

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. Corresponds to the JSON property `maxQps` @return [Fixnum]

name[RW]

The resource name of the ScanConfig. The name follows the format of 'projects/` projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by the system. Corresponds to the JSON property `name` @return [String]

risk_level[RW]

The risk level selected for the scan Corresponds to the JSON property `riskLevel` @return [String]

schedule[RW]

Scan schedule configuration. Corresponds to the JSON property `schedule` @return [Google::Apis::WebsecurityscannerV1beta::Schedule]

starting_urls[RW]

Required. The starting URLs from which the scanner finds site pages. Corresponds to the JSON property `startingUrls` @return [Array<String>]

static_ip_scan[RW]

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. Corresponds to the JSON property `staticIpScan` @return [Boolean]

static_ip_scan?[RW]

Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. Corresponds to the JSON property `staticIpScan` @return [Boolean]

target_platforms[RW]

Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. Corresponds to the JSON property `targetPlatforms` @return [Array<String>]

user_agent[RW]

The user agent used during scanning. Corresponds to the JSON property `userAgent` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/websecurityscanner_v1beta/classes.rb, line 651
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/websecurityscanner_v1beta/classes.rb, line 656
def update!(**args)
  @authentication = args[:authentication] if args.key?(:authentication)
  @blacklist_patterns = args[:blacklist_patterns] if args.key?(:blacklist_patterns)
  @display_name = args[:display_name] if args.key?(:display_name)
  @export_to_security_command_center = args[:export_to_security_command_center] if args.key?(:export_to_security_command_center)
  @ignore_http_status_errors = args[:ignore_http_status_errors] if args.key?(:ignore_http_status_errors)
  @latest_run = args[:latest_run] if args.key?(:latest_run)
  @managed_scan = args[:managed_scan] if args.key?(:managed_scan)
  @max_qps = args[:max_qps] if args.key?(:max_qps)
  @name = args[:name] if args.key?(:name)
  @risk_level = args[:risk_level] if args.key?(:risk_level)
  @schedule = args[:schedule] if args.key?(:schedule)
  @starting_urls = args[:starting_urls] if args.key?(:starting_urls)
  @static_ip_scan = args[:static_ip_scan] if args.key?(:static_ip_scan)
  @target_platforms = args[:target_platforms] if args.key?(:target_platforms)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
end