Class: Google::Apis::WebsecurityscannerV1::ScanConfig
- Inherits:
-
Object
- Object
- Google::Apis::WebsecurityscannerV1::ScanConfig
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/websecurityscanner_v1/classes.rb,
generated/google/apis/websecurityscanner_v1/representations.rb,
generated/google/apis/websecurityscanner_v1/representations.rb
Overview
A ScanConfig resource contains the configurations to launch a scan.
Instance Attribute Summary collapse
-
#authentication ⇒ Google::Apis::WebsecurityscannerV1::Authentication
Scan authentication configuration.
-
#blacklist_patterns ⇒ Array<String>
The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls Corresponds to the JSON property
blacklistPatterns
. -
#display_name ⇒ String
Required.
-
#export_to_security_command_center ⇒ String
Controls export of scan configurations and results to Cloud Security Command Center.
-
#managed_scan ⇒ Boolean
(also: #managed_scan?)
Whether the scan config is managed by Cloud Web Security Scanner, output only.
-
#max_qps ⇒ Fixnum
The maximum QPS during scanning.
-
#name ⇒ String
The resource name of the ScanConfig.
-
#risk_level ⇒ String
The risk level selected for the scan Corresponds to the JSON property
riskLevel
. -
#schedule ⇒ Google::Apis::WebsecurityscannerV1::Schedule
Scan schedule configuration.
-
#starting_urls ⇒ Array<String>
Required.
-
#static_ip_scan ⇒ Boolean
(also: #static_ip_scan?)
Whether the scan configuration has enabled static IP address scan feature.
-
#user_agent ⇒ String
The user agent used during scanning.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ScanConfig
constructor
A new instance of ScanConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ScanConfig
Returns a new instance of ScanConfig.
642 643 644 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 642 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authentication ⇒ Google::Apis::WebsecurityscannerV1::Authentication
Scan authentication configuration.
Corresponds to the JSON property authentication
574 575 576 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 574 def authentication @authentication end |
#blacklist_patterns ⇒ Array<String>
The blacklist URL patterns as described in
https://cloud.google.com/security-scanner/docs/excluded-urls
Corresponds to the JSON property blacklistPatterns
580 581 582 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 580 def blacklist_patterns @blacklist_patterns end |
#display_name ⇒ String
Required. The user provided display name of the ScanConfig.
Corresponds to the JSON property displayName
585 586 587 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 585 def display_name @display_name end |
#export_to_security_command_center ⇒ String
Controls export of scan configurations and results to Cloud Security
Command Center.
Corresponds to the JSON property exportToSecurityCommandCenter
591 592 593 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 591 def export_to_security_command_center @export_to_security_command_center end |
#managed_scan ⇒ Boolean Also known as: managed_scan?
Whether the scan config is managed by Cloud Web Security Scanner, output
only.
Corresponds to the JSON property managedScan
597 598 599 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 597 def managed_scan @managed_scan end |
#max_qps ⇒ Fixnum
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
606 607 608 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 606 def max_qps @max_qps end |
#name ⇒ String
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
613 614 615 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 613 def name @name end |
#risk_level ⇒ String
The risk level selected for the scan
Corresponds to the JSON property riskLevel
618 619 620 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 618 def risk_level @risk_level end |
#schedule ⇒ Google::Apis::WebsecurityscannerV1::Schedule
Scan schedule configuration.
Corresponds to the JSON property schedule
623 624 625 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 623 def schedule @schedule end |
#starting_urls ⇒ Array<String>
Required. The starting URLs from which the scanner finds site pages.
Corresponds to the JSON property startingUrls
628 629 630 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 628 def starting_urls @starting_urls end |
#static_ip_scan ⇒ Boolean Also known as: static_ip_scan?
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
634 635 636 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 634 def static_ip_scan @static_ip_scan end |
#user_agent ⇒ String
The user agent used during scanning.
Corresponds to the JSON property userAgent
640 641 642 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 640 def user_agent @user_agent end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
647 648 649 650 651 652 653 654 655 656 657 658 659 660 |
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 647 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) @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) @user_agent = args[:user_agent] if args.key?(:user_agent) end |