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
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
-
#error_trace ⇒ Google::Apis::WebsecurityscannerV1beta::ScanRunErrorTrace
Output only.
-
#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.
-
#warning_traces ⇒ Array<Google::Apis::WebsecurityscannerV1beta::ScanRunWarningTrace>
A list of warnings, if such are encountered during this scan run.
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.
775 776 777 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 775 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
711 712 713 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 711 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
717 718 719 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 717 def error_trace @error_trace end |
#execution_state ⇒ String
The execution state of the ScanRun.
Corresponds to the JSON property executionState
722 723 724 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 722 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
727 728 729 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 727 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
735 736 737 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 735 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
743 744 745 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 743 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
749 750 751 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 749 def result_state @result_state end |
#start_time ⇒ String
The time at which the ScanRun started.
Corresponds to the JSON property startTime
754 755 756 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 754 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
760 761 762 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 760 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
768 769 770 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 768 def urls_tested_count @urls_tested_count end |
#warning_traces ⇒ Array<Google::Apis::WebsecurityscannerV1beta::ScanRunWarningTrace>
A list of warnings, if such are encountered during this scan run.
Corresponds to the JSON property warningTraces
773 774 775 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 773 def warning_traces @warning_traces end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
780 781 782 783 784 785 786 787 788 789 790 791 792 |
# File 'generated/google/apis/websecurityscanner_v1beta/classes.rb', line 780 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 |