Class: Google::Apis::WebsecurityscannerV1alpha::ScanRun

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ScanRun

Returns a new instance of ScanRun.



616
617
618
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 616

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

Returns:

  • (String) 


564
565
566
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 564

def end_time
  @end_time
end

#execution_state ⇒ String

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

Returns:

  • (String) 


569
570
571
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 569

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

Returns:

  • (Boolean) 


574
575
576
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 574

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

Returns:

  • (String) 


582
583
584
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 582

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

Returns:

  • (Fixnum) 


589
590
591
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 589

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

Returns:

  • (String) 


595
596
597
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 595

def result_state
  @result_state
end

#start_time ⇒ String

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

Returns:

  • (String) 


600
601
602
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 600

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

Returns:

  • (Fixnum) 


606
607
608
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 606

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

Returns:

  • (Fixnum) 


614
615
616
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 614

def urls_tested_count
  @urls_tested_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



621
622
623
624
625
626
627
628
629
630
631
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 621

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