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

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 ScanConfig resource contains the configurations to launch a scan.

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) ⇒ ScanConfig

Returns a new instance of ScanConfig



528
529
530
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 528

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

Instance Attribute Details

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

Scan authentication configuration. Corresponds to the JSON property authentication

Returns:



477
478
479
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 477

def authentication
  @authentication
end

#blacklist_patterns ⇒ Array<String>

The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls Corresponds to the JSON property blacklistPatterns

Returns:

  • (Array<String>) 


483
484
485
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 483

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) 


489
490
491
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 489

def display_name
  @display_name
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) 


497
498
499
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 497

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) 


504
505
506
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 504

def name
  @name
end

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

Scan schedule configuration. Corresponds to the JSON property schedule

Returns:



509
510
511
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 509

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>) 


515
516
517
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 515

def starting_urls
  @starting_urls
end

#target_platforms ⇒ Array<String>

Set of 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>) 


521
522
523
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 521

def target_platforms
  @target_platforms
end

#user_agent ⇒ String

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

Returns:

  • (String) 


526
527
528
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 526

def user_agent
  @user_agent
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



533
534
535
536
537
538
539
540
541
542
543
 
# File 'generated/google/apis/websecurityscanner_v1alpha/classes.rb', line 533

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)
  @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