Reference documentation and code samples for the Google Cloud Web Security Scanner V1 Client class 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.
Generated from protobuf messagegoogle.cloud.websecurityscanner.v1.ScanConfigError
Namespace
Google \ Cloud \ WebSecurityScanner \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ code
int
Output only. Indicates the reason code for a configuration failure.
↳ 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.
getCode
Output only. Indicates the reason code for a configuration failure.
Returns
Type
Description
int
setCode
Output only. Indicates the reason code for a configuration failure.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getFieldName
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
Type
Description
string
setFieldName
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-04 UTC."],[],[],null,["# Google Cloud Web Security Scanner V1 Client - Class ScanConfigError (1.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.5 (latest)](/php/docs/reference/cloud-web-security-scanner/latest/V1.ScanConfigError)\n- [1.0.4](/php/docs/reference/cloud-web-security-scanner/1.0.4/V1.ScanConfigError)\n- [0.8.5](/php/docs/reference/cloud-web-security-scanner/0.8.5/V1.ScanConfigError)\n- [0.7.18](/php/docs/reference/cloud-web-security-scanner/0.7.18/V1.ScanConfigError) \nReference documentation and code samples for the Google Cloud Web Security Scanner V1 Client class 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\nGenerated from protobuf message `google.cloud.websecurityscanner.v1.ScanConfigError`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ WebSecurityScanner \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCode\n\nOutput only. Indicates the reason code for a configuration failure.\n\n### setCode\n\nOutput only. Indicates the reason code for a configuration failure.\n\n### getFieldName\n\nOutput only. Indicates the full name of the ScanConfig field that triggers this error,\nfor example \"scan_config.max_qps\". This field is provided for\ntroubleshooting purposes only and its actual value can change in the\nfuture.\n\n### setFieldName\n\nOutput only. Indicates the full name of the ScanConfig field that triggers this error,\nfor example \"scan_config.max_qps\". This field is provided for\ntroubleshooting purposes only and its actual value can change in the\nfuture."]]
