Class ScanConfigError (2.5.0)

public final class ScanConfigError extends GeneratedMessageV3 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.v1.ScanConfigError

Static Fields

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER
Field Value
TypeDescription
int

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ScanConfigError getDefaultInstance()
Returns
TypeDescription
ScanConfigError

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ScanConfigError.Builder newBuilder()
Returns
TypeDescription
ScanConfigError.Builder

newBuilder(ScanConfigError prototype)

public static ScanConfigError.Builder newBuilder(ScanConfigError prototype)
Parameter
NameDescription
prototypeScanConfigError
Returns
TypeDescription
ScanConfigError.Builder

parseDelimitedFrom(InputStream input)

public static ScanConfigError parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ScanConfigError parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ScanConfigError parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ScanConfigError parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ScanConfigError parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ScanConfigError parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ScanConfigError parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ScanConfigError parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ScanConfigError parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ScanConfigError parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ScanConfigError parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ScanConfigError parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ScanConfigError
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ScanConfigError> parser()
Returns
TypeDescription
Parser<ScanConfigError>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCode()

public ScanConfigError.Code getCode()

Output only. Indicates the reason code for a configuration failure.

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

Returns
TypeDescription
ScanConfigError.Code

The code.

getCodeValue()

public int getCodeValue()

Output only. Indicates the reason code for a configuration failure.

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

Returns
TypeDescription
int

The enum numeric value on the wire for code.

getDefaultInstanceForType()

public ScanConfigError getDefaultInstanceForType()
Returns
TypeDescription
ScanConfigError

getFieldName()

public String 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.

string field_name = 2;

Returns
TypeDescription
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

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.

string field_name = 2;

Returns
TypeDescription
ByteString

The bytes for fieldName.

getParserForType()

public Parser<ScanConfigError> getParserForType()
Returns
TypeDescription
Parser<ScanConfigError>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ScanConfigError.Builder newBuilderForType()
Returns
TypeDescription
ScanConfigError.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ScanConfigError.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ScanConfigError.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ScanConfigError.Builder toBuilder()
Returns
TypeDescription
ScanConfigError.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException