Class: Google::Apis::WebsecurityscannerV1beta::ScanRun
- Inherits:
-
Object
- Object
- Google::Apis::WebsecurityscannerV1beta::ScanRun
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/websecurityscanner_v1beta/classes.rb,
generated/google/apis/websecurityscanner_v1beta/representations.rb,
generated/google/apis/websecurityscanner_v1beta/representations.rb
Overview
A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Instance Attribute Summary collapse
-
#end_time ⇒ String
Output only.
-
#error_trace ⇒ Google::Apis::WebsecurityscannerV1beta::ScanRunErrorTrace
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.
-
#warning_traces ⇒ Array<Google::Apis::WebsecurityscannerV1beta::ScanRunWarningTrace>
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
723 724 725 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 723 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
656 657 658 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 656 def end_time @end_time end |
#error_trace ⇒ Google::Apis::WebsecurityscannerV1beta::ScanRunErrorTrace
Output only.
Defines an error trace message for a ScanRun.
Corresponds to the JSON property errorTrace
662 663 664 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 662 def error_trace @error_trace end |
#execution_state ⇒ String
Output only. The execution state of the ScanRun.
Corresponds to the JSON property executionState
667 668 669 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 667 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
672 673 674 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 672 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
680 681 682 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 680 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
688 689 690 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 688 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
695 696 697 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 695 def result_state @result_state end |
#start_time ⇒ String
Output only. The time at which the ScanRun started.
Corresponds to the JSON property startTime
700 701 702 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 700 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
707 708 709 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 707 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
716 717 718 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 716 def urls_tested_count @urls_tested_count end |
#warning_traces ⇒ Array<Google::Apis::WebsecurityscannerV1beta::ScanRunWarningTrace>
Output only. A list of warnings, if such are encountered during this scan run.
Corresponds to the JSON property warningTraces
721 722 723 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 721 def warning_traces @warning_traces end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
728 729 730 731 732 733 734 735 736 737 738 739 740 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 728 def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @error_trace = args[:error_trace] if args.key?(:error_trace) @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) @warning_traces = args[:warning_traces] if args.key?(:warning_traces) end |