Class: Google::Apis::WebsecurityscannerV1alpha::ScanRun
- Inherits:
-
Object
- Object
- Google::Apis::WebsecurityscannerV1alpha::ScanRun
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/websecurityscanner_v1alpha/classes.rb,
lib/google/apis/websecurityscanner_v1alpha/representations.rb,
lib/google/apis/websecurityscanner_v1alpha/representations.rb
Overview
A ScanRun is a output-only resource representing an actual run of the scan.
Instance Attribute Summary collapse
-
#end_time ⇒ String
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
-
#execution_state ⇒ String
The execution state of the ScanRun.
-
#has_vulnerabilities ⇒ Boolean
(also: #has_vulnerabilities?)
Whether the scan run has found any vulnerabilities.
-
#name ⇒ String
The resource name of the ScanRun.
-
#progress_percent ⇒ Fixnum
The percentage of total completion ranging from 0 to 100.
-
#result_state ⇒ String
The result state of the ScanRun.
-
#start_time ⇒ String
The time at which the ScanRun started.
-
#urls_crawled_count ⇒ Fixnum
The number of URLs crawled during this ScanRun.
-
#urls_tested_count ⇒ Fixnum
The number of URLs tested during this ScanRun.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ScanRun
constructor
A new instance of ScanRun.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ ScanRun
Returns a new instance of ScanRun.
615 616 617 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 615 def initialize(**args) update!(**args) end |
Instance Attribute Details
#end_time ⇒ String
The time at which the ScanRun reached termination state - that the ScanRun is
either finished or stopped by user.
Corresponds to the JSON property endTime
563 564 565 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 563 def end_time @end_time end |
#execution_state ⇒ String
The execution state of the ScanRun.
Corresponds to the JSON property executionState
568 569 570 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 568 def execution_state @execution_state end |
#has_vulnerabilities ⇒ Boolean Also known as: has_vulnerabilities?
Whether the scan run has found any vulnerabilities.
Corresponds to the JSON property hasVulnerabilities
573 574 575 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 573 def has_vulnerabilities @has_vulnerabilities end |
#name ⇒ String
The resource name of the ScanRun. The name follows the format of 'projects/
projectId
/scanConfigs/scanConfigId
/scanRuns/scanRunId
'. The ScanRun IDs
are generated by the system.
Corresponds to the JSON property name
581 582 583 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 581 def name @name end |
#progress_percent ⇒ Fixnum
The percentage of total completion ranging from 0 to 100. If the scan is in
queue, the value is 0. If the scan is running, the value ranges from 0 to 100.
If the scan is finished, the value is 100.
Corresponds to the JSON property progressPercent
588 589 590 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 588 def progress_percent @progress_percent end |
#result_state ⇒ String
The result state of the ScanRun. This field is only available after the
execution state reaches "FINISHED".
Corresponds to the JSON property resultState
594 595 596 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 594 def result_state @result_state end |
#start_time ⇒ String
The time at which the ScanRun started.
Corresponds to the JSON property startTime
599 600 601 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 599 def start_time @start_time end |
#urls_crawled_count ⇒ Fixnum
The number of URLs crawled during this ScanRun. If the scan is in progress,
the value represents the number of URLs crawled up to now.
Corresponds to the JSON property urlsCrawledCount
605 606 607 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 605 def urls_crawled_count @urls_crawled_count end |
#urls_tested_count ⇒ Fixnum
The number of URLs tested during this ScanRun. If the scan is in progress, the
value represents the number of URLs tested up to now. The number of URLs
tested is usually larger than the number URLS crawled because typically a
crawled URL is tested with multiple test payloads.
Corresponds to the JSON property urlsTestedCount
613 614 615 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 613 def urls_tested_count @urls_tested_count end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
620 621 622 623 624 625 626 627 628 629 630 |
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 620 def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @execution_state = args[:execution_state] if args.key?(:execution_state) @has_vulnerabilities = args[:has_vulnerabilities] if args.key?(:has_vulnerabilities) @name = args[:name] if args.key?(:name) @progress_percent = args[:progress_percent] if args.key?(:progress_percent) @result_state = args[:result_state] if args.key?(:result_state) @start_time = args[:start_time] if args.key?(:start_time) @urls_crawled_count = args[:urls_crawled_count] if args.key?(:urls_crawled_count) @urls_tested_count = args[:urls_tested_count] if args.key?(:urls_tested_count) end |