Class: Google::Apis::WebsecurityscannerV1::ScanConfigError

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

Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ScanConfigError

Returns a new instance of ScanConfigError.



688
689
690
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 688

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

Instance Attribute Details

#code ⇒ String

Output only. Indicates the reason code for a configuration failure. Corresponds to the JSON property code

Returns:

  • (String) 


679
680
681
 
# File 'lib/google/apis/websecurityscanner_v1/classes.rb', line 679

def code
  @code
end

#field_name ⇒ String

Output only. Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future. Corresponds to the JSON property fieldName

Returns:

  • (String) 


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

def field_name
  @field_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

def update!(**args)
  @code = args[:code] if args.key?(:code)
  @field_name = args[:field_name] if args.key?(:field_name)
end