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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/websecurityscanner_v1/classes.rb,
generated/google/apis/websecurityscanner_v1/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ScanRun

Returns a new instance of ScanRun



709
710
711
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 709

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) 


642
643
644
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 642

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:



648
649
650
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 648

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) 


653
654
655
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 653

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) 


658
659
660
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 658

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) 


666
667
668
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 666

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) 


674
675
676
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 674

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) 


681
682
683
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 681

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) 


686
687
688
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 686

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) 


693
694
695
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 693

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) 


702
703
704
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 702

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:



707
708
709
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 707

def warning_traces
  @warning_traces
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 714

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