Class: Google::Apis::WebsecurityscannerV1alpha::ScanConfig
- Inherits:
-
Object
- Object
- Google::Apis::WebsecurityscannerV1alpha::ScanConfig
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/websecurityscanner_v1alpha/classes.rb,
generated/google/apis/websecurityscanner_v1alpha/representations.rb,
generated/google/apis/websecurityscanner_v1alpha/representations.rb
Overview
A ScanConfig resource contains the configurations to launch a scan.
Instance Attribute Summary collapse
-
#authentication ⇒ Google::Apis::WebsecurityscannerV1alpha::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.
-
#max_qps ⇒ Fixnum
The maximum QPS during scanning.
-
#name ⇒ String
The resource name of the ScanConfig.
-
#schedule ⇒ Google::Apis::WebsecurityscannerV1alpha::Schedule
Scan schedule configuration.
-
#starting_urls ⇒ Array<String>
Required.
-
#target_platforms ⇒ Array<String>
Set of Cloud Platforms targeted by the scan.
-
#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
559 560 561 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 559 def initialize(**args) update!(**args) end |
Instance Attribute Details
#authentication ⇒ Google::Apis::WebsecurityscannerV1alpha::Authentication
Scan authentication configuration.
Corresponds to the JSON property authentication
508 509 510 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 508 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
514 515 516 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 514 def blacklist_patterns @blacklist_patterns end |
#display_name ⇒ String
Required.
The user provided display name of the ScanConfig.
Corresponds to the JSON property displayName
520 521 522 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 520 def display_name @display_name 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
528 529 530 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 528 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
535 536 537 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 535 def name @name end |
#schedule ⇒ Google::Apis::WebsecurityscannerV1alpha::Schedule
Scan schedule configuration.
Corresponds to the JSON property schedule
540 541 542 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 540 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
546 547 548 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 546 def starting_urls @starting_urls end |
#target_platforms ⇒ Array<String>
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be
used as a default.
Corresponds to the JSON property targetPlatforms
552 553 554 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 552 def target_platforms @target_platforms end |
#user_agent ⇒ String
The user agent used during scanning.
Corresponds to the JSON property userAgent
557 558 559 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 557 def user_agent @user_agent end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
564 565 566 567 568 569 570 571 572 573 574 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 564 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) @max_qps = args[:max_qps] if args.key?(:max_qps) @name = args[:name] if args.key?(:name) @schedule = args[:schedule] if args.key?(:schedule) @starting_urls = args[:starting_urls] if args.key?(:starting_urls) @target_platforms = args[:target_platforms] if args.key?(:target_platforms) @user_agent = args[:user_agent] if args.key?(:user_agent) end |