Class: Google::Apis::WebsecurityscannerV1alpha::ScanConfig

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

Overview

A ScanConfig resource contains the configurations to launch a scan. next id: 12

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ScanConfig

Returns a new instance of ScanConfig.



536
537
538
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 536

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#authentication ⇒ Google::Apis::WebsecurityscannerV1alpha::Authentication

Scan authentication configuration. Corresponds to the JSON property authentication

Returns:



482
483
484
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 482

def authentication
  @authentication
end

#blacklist_patterns ⇒ Array<String>

The excluded URL patterns as described in https://cloud.google.com/security- command-center/docs/how-to-use-web-security-scanner#excluding_urls Corresponds to the JSON property blacklistPatterns

Returns:

  • (Array<String>) 


488
489
490
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 488

def blacklist_patterns
  @blacklist_patterns
end

#display_name ⇒ String

Required. The user provided display name of the ScanConfig. Corresponds to the JSON property displayName

Returns:

  • (String) 


493
494
495
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 493

def display_name
  @display_name
end

#latest_run ⇒ Google::Apis::WebsecurityscannerV1alpha::ScanRun

A ScanRun is a output-only resource representing an actual run of the scan. Corresponds to the JSON property latestRun

Returns:



498
499
500
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 498

def latest_run
  @latest_run
end

#max_qps ⇒ Fixnum

The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. Corresponds to the JSON property maxQps

Returns:

  • (Fixnum) 


506
507
508
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 506

def max_qps
  @max_qps
end

#name ⇒ String

The resource name of the ScanConfig. The name follows the format of 'projects/ projectId/scanConfigs/scanConfigId'. The ScanConfig IDs are generated by the system. Corresponds to the JSON property name

Returns:

  • (String) 


513
514
515
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 513

def name
  @name
end

#schedule ⇒ Google::Apis::WebsecurityscannerV1alpha::Schedule

Scan schedule configuration. Corresponds to the JSON property schedule

Returns:



518
519
520
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 518

def schedule
  @schedule
end

#starting_urls ⇒ Array<String>

Required. The starting URLs from which the scanner finds site pages. Corresponds to the JSON property startingUrls

Returns:

  • (Array<String>) 


523
524
525
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 523

def starting_urls
  @starting_urls
end

#target_platforms ⇒ Array<String>

Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will be used as a default. Corresponds to the JSON property targetPlatforms

Returns:

  • (Array<String>) 


529
530
531
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 529

def target_platforms
  @target_platforms
end

#user_agent ⇒ String

The user agent used during scanning. Corresponds to the JSON property userAgent

Returns:

  • (String) 


534
535
536
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 534

def user_agent
  @user_agent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/google/apis/websecurityscanner_v1alpha/classes.rb', line 541

def update!(**args)
  @authentication = args[:authentication] if args.key?(:authentication)
  @blacklist_patterns = args[:blacklist_patterns] if args.key?(:blacklist_patterns)
  @display_name = args[:display_name] if args.key?(:display_name)
  @latest_run = args[:latest_run] if args.key?(:latest_run)
  @max_qps = args[:max_qps] if args.key?(:max_qps)
  @name = args[:name] if args.key?(:name)
  @schedule = args[:schedule] if args.key?(:schedule)
  @starting_urls = args[:starting_urls] if args.key?(:starting_urls)
  @target_platforms = args[:target_platforms] if args.key?(:target_platforms)
  @user_agent = args[:user_agent] if args.key?(:user_agent)
end