Class: Google::Apis::WebsecurityscannerV1alpha::ScanRun
- Inherits:
-
Object
- Object
- Google::Apis::WebsecurityscannerV1alpha::ScanRun
- 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 ScanRun is a output-only resource representing an actual run of the scan.
Instance Attribute Summary collapse
-
#end_time ⇒ String
Output only.
-
#execution_state ⇒ String
Output only.
-
#has_vulnerabilities ⇒ Boolean
(also: #has_vulnerabilities?)
Output only.
-
#name ⇒ String
Output only.
-
#progress_percent ⇒ Fixnum
Output only.
-
#result_state ⇒ String
Output only.
-
#start_time ⇒ String
Output only.
-
#urls_crawled_count ⇒ Fixnum
Output only.
-
#urls_tested_count ⇒ Fixnum
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ScanRun
constructor
A new instance of ScanRun.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ScanRun
Returns a new instance of ScanRun
633 634 635 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 633 def initialize(**args) update!(**args) end |
Instance Attribute Details
#end_time ⇒ String
Output only. 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
577 578 579 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 577 def end_time @end_time end |
#execution_state ⇒ String
Output only. The execution state of the ScanRun.
Corresponds to the JSON property executionState
582 583 584 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 582 def execution_state @execution_state end |
#has_vulnerabilities ⇒ Boolean Also known as: has_vulnerabilities?
Output only. Whether the scan run has found any vulnerabilities.
Corresponds to the JSON property hasVulnerabilities
587 588 589 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 587 def has_vulnerabilities @has_vulnerabilities end |
#name ⇒ String
Output only. 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
595 596 597 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 595 def name @name end |
#progress_percent ⇒ Fixnum
Output only. 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
603 604 605 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 603 def progress_percent @progress_percent end |
#result_state ⇒ String
Output only. The result state of the ScanRun. This field is only available
after the
execution state reaches "FINISHED".
Corresponds to the JSON property resultState
610 611 612 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 610 def result_state @result_state end |
#start_time ⇒ String
Output only. The time at which the ScanRun started.
Corresponds to the JSON property startTime
615 616 617 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 615 def start_time @start_time end |
#urls_crawled_count ⇒ Fixnum
Output only. 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
622 623 624 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 622 def urls_crawled_count @urls_crawled_count end |
#urls_tested_count ⇒ Fixnum
Output only. 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
631 632 633 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 631 def urls_tested_count @urls_tested_count end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
638 639 640 641 642 643 644 645 646 647 648 |
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 638 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 |