Class ScanConfigError.Builder (2.85.0)

public static final class ScanConfigError.Builder extends GeneratedMessage.Builder<ScanConfigError.Builder> implements ScanConfigErrorOrBuilder

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.

Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfigError

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ScanConfigError build()
Returns
Type Description
ScanConfigError

buildPartial()

public ScanConfigError buildPartial()
Returns
Type Description
ScanConfigError

clear()

public ScanConfigError.Builder clear()
Returns
Type Description
ScanConfigError.Builder
Overrides

clearCode()

public ScanConfigError.Builder clearCode()

Indicates the reason code for a configuration failure.

.google.cloud.websecurityscanner.v1beta.ScanConfigError.Code code = 1;

Returns
Type Description
ScanConfigError.Builder

This builder for chaining.

clearFieldName()

public ScanConfigError.Builder clearFieldName()

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.

string field_name = 2;

Returns
Type Description
ScanConfigError.Builder

This builder for chaining.

getCode()

public ScanConfigError.Code getCode()

Indicates the reason code for a configuration failure.

.google.cloud.websecurityscanner.v1beta.ScanConfigError.Code code = 1;

Returns
Type Description
ScanConfigError.Code

The code.

getCodeValue()

public int getCodeValue()

Indicates the reason code for a configuration failure.

.google.cloud.websecurityscanner.v1beta.ScanConfigError.Code code = 1;

Returns
Type Description
int

The enum numeric value on the wire for code.

getDefaultInstanceForType()

public ScanConfigError getDefaultInstanceForType()
Returns
Type Description
ScanConfigError

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFieldName()

public String getFieldName()

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.

string field_name = 2;

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

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.

string field_name = 2;

Returns
Type Description
ByteString

The bytes for fieldName.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ScanConfigError other)

public ScanConfigError.Builder mergeFrom(ScanConfigError other)
Parameter
Name Description
other ScanConfigError
Returns
Type Description
ScanConfigError.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ScanConfigError.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScanConfigError.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ScanConfigError.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ScanConfigError.Builder
Overrides

setCode(ScanConfigError.Code value)

public ScanConfigError.Builder setCode(ScanConfigError.Code value)

Indicates the reason code for a configuration failure.

.google.cloud.websecurityscanner.v1beta.ScanConfigError.Code code = 1;

Parameter
Name Description
value ScanConfigError.Code

The code to set.

Returns
Type Description
ScanConfigError.Builder

This builder for chaining.

setCodeValue(int value)

public ScanConfigError.Builder setCodeValue(int value)

Indicates the reason code for a configuration failure.

.google.cloud.websecurityscanner.v1beta.ScanConfigError.Code code = 1;

Parameter
Name Description
value int

The enum numeric value on the wire for code to set.

Returns
Type Description
ScanConfigError.Builder

This builder for chaining.

setFieldName(String value)

public ScanConfigError.Builder setFieldName(String value)

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.

string field_name = 2;

Parameter
Name Description
value String

The fieldName to set.

Returns
Type Description
ScanConfigError.Builder

This builder for chaining.

setFieldNameBytes(ByteString value)

public ScanConfigError.Builder setFieldNameBytes(ByteString value)

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.

string field_name = 2;

Parameter
Name Description
value ByteString

The bytes for fieldName to set.

Returns
Type Description
ScanConfigError.Builder

This builder for chaining.