Class: Google::Apis::WebsecurityscannerV1::ScanRun

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/websecurityscanner_v1/classes.rb,
lib/google/apis/websecurityscanner_v1/representations.rb,
lib/google/apis/websecurityscanner_v1/representations.rb

Overview

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ScanRun

Returns a new instance of ScanRun.



770
771
772
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 770

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

Returns:

  • (String) 


708
709
710
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 708

def end_time
  @end_time
end

#error_trace ⇒ Google::Apis::WebsecurityscannerV1::ScanRunErrorTrace

Output only. Defines an error trace message for a ScanRun. Corresponds to the JSON property errorTrace

Returns:



713
714
715
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 713

def error_trace
  @error_trace
end

#execution_state ⇒ String

Output only. The execution state of the ScanRun. Corresponds to the JSON property executionState

Returns:

  • (String) 


718
719
720
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 718

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

Returns:

  • (Boolean) 


723
724
725
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 723

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

Returns:

  • (String) 


731
732
733
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 731

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

Returns:

  • (Fixnum) 


738
739
740
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 738

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

Returns:

  • (String) 


744
745
746
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 744

def result_state
  @result_state
end

#start_time ⇒ String

Output only. The time at which the ScanRun started. Corresponds to the JSON property startTime

Returns:

  • (String) 


749
750
751
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 749

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

Returns:

  • (Fixnum) 


755
756
757
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 755

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

Returns:

  • (Fixnum) 


763
764
765
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 763

def urls_tested_count
  @urls_tested_count
end

#warning_traces ⇒ Array<Google::Apis::WebsecurityscannerV1::ScanRunWarningTrace>

Output only. A list of warnings, if such are encountered during this scan run. Corresponds to the JSON property warningTraces

Returns:



768
769
770
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 768

def warning_traces
  @warning_traces
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



775
776
777
778
779
780
781
782
783
784
785
786
787
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 775

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