Reference documentation and code samples for the Web Security Scanner V1 API class Google::Cloud::WebSecurityScanner::V1::ScanConfigError.
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.
(::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.
#field_name=
deffield_name=(value)->::String
Parameter
value (::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.
Returns
(::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Web Security Scanner V1 API - Class Google::Cloud::WebSecurityScanner::V1::ScanConfigError (v1.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.0 (latest)](/ruby/docs/reference/google-cloud-web_security_scanner-v1/latest/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [1.2.1](/ruby/docs/reference/google-cloud-web_security_scanner-v1/1.2.1/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [1.1.0](/ruby/docs/reference/google-cloud-web_security_scanner-v1/1.1.0/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [1.0.1](/ruby/docs/reference/google-cloud-web_security_scanner-v1/1.0.1/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.10.0](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.10.0/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.9.2](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.9.2/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.8.0](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.8.0/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.7.1](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.7.1/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.6.0](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.6.0/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.5.0](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.5.0/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.4.1](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.4.1/Google-Cloud-WebSecurityScanner-V1-ScanConfigError)\n- [0.3.5](/ruby/docs/reference/google-cloud-web_security_scanner-v1/0.3.5/Google-Cloud-WebSecurityScanner-V1-ScanConfigError) \nReference documentation and code samples for the Web Security Scanner V1 API class Google::Cloud::WebSecurityScanner::V1::ScanConfigError.\n\nDefines a custom error message used by CreateScanConfig and UpdateScanConfig\nAPIs when scan configuration validation fails. It is also reported as part of\na ScanRunErrorTrace message if scan validation fails due to a scan\nconfiguration error. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #code\n\n def code() -\u003e ::Google::Cloud::WebSecurityScanner::V1::ScanConfigError::Code\n\n**Returns**\n\n- ([::Google::Cloud::WebSecurityScanner::V1::ScanConfigError::Code](./Google-Cloud-WebSecurityScanner-V1-ScanConfigError-Code)) --- Output only. Indicates the reason code for a configuration failure.\n\n### #code=\n\n def code=(value) -\u003e ::Google::Cloud::WebSecurityScanner::V1::ScanConfigError::Code\n\n**Parameter**\n\n- **value** ([::Google::Cloud::WebSecurityScanner::V1::ScanConfigError::Code](./Google-Cloud-WebSecurityScanner-V1-ScanConfigError-Code)) --- Output only. Indicates the reason code for a configuration failure. \n**Returns**\n\n- ([::Google::Cloud::WebSecurityScanner::V1::ScanConfigError::Code](./Google-Cloud-WebSecurityScanner-V1-ScanConfigError-Code)) --- Output only. Indicates the reason code for a configuration failure.\n\n### #field_name\n\n def field_name() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #field_name=\n\n def field_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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."]]
