Class Finding (2.27.0)

public final class Finding extends GeneratedMessageV3 implements FindingOrBuilder

A Finding resource represents a vulnerability instance identified during a ScanRun.

Protobuf type google.cloud.websecurityscanner.v1.Finding

Implements

FindingOrBuilder

Static Fields

BODY_FIELD_NUMBER

public static final int BODY_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

FINAL_URL_FIELD_NUMBER

public static final int FINAL_URL_FIELD_NUMBER
Field Value
TypeDescription
int

FINDING_TYPE_FIELD_NUMBER

public static final int FINDING_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

FORM_FIELD_NUMBER

public static final int FORM_FIELD_NUMBER
Field Value
TypeDescription
int

FRAME_URL_FIELD_NUMBER

public static final int FRAME_URL_FIELD_NUMBER
Field Value
TypeDescription
int

FUZZED_URL_FIELD_NUMBER

public static final int FUZZED_URL_FIELD_NUMBER
Field Value
TypeDescription
int

HTTP_METHOD_FIELD_NUMBER

public static final int HTTP_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OUTDATED_LIBRARY_FIELD_NUMBER

public static final int OUTDATED_LIBRARY_FIELD_NUMBER
Field Value
TypeDescription
int

REPRODUCTION_URL_FIELD_NUMBER

public static final int REPRODUCTION_URL_FIELD_NUMBER
Field Value
TypeDescription
int

SEVERITY_FIELD_NUMBER

public static final int SEVERITY_FIELD_NUMBER
Field Value
TypeDescription
int

TRACKING_ID_FIELD_NUMBER

public static final int TRACKING_ID_FIELD_NUMBER
Field Value
TypeDescription
int

VIOLATING_RESOURCE_FIELD_NUMBER

public static final int VIOLATING_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

VULNERABLE_HEADERS_FIELD_NUMBER

public static final int VULNERABLE_HEADERS_FIELD_NUMBER
Field Value
TypeDescription
int

VULNERABLE_PARAMETERS_FIELD_NUMBER

public static final int VULNERABLE_PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

XSS_FIELD_NUMBER

public static final int XSS_FIELD_NUMBER
Field Value
TypeDescription
int

XXE_FIELD_NUMBER

public static final int XXE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Finding getDefaultInstance()
Returns
TypeDescription
Finding

getDescriptor()

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

newBuilder()

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

newBuilder(Finding prototype)

public static Finding.Builder newBuilder(Finding prototype)
Parameter
NameDescription
prototypeFinding
Returns
TypeDescription
Finding.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBody()

public String getBody()

Output only. The body of the request that triggered the vulnerability.

string body = 5;

Returns
TypeDescription
String

The body.

getBodyBytes()

public ByteString getBodyBytes()

Output only. The body of the request that triggered the vulnerability.

string body = 5;

Returns
TypeDescription
ByteString

The bytes for body.

getDefaultInstanceForType()

public Finding getDefaultInstanceForType()
Returns
TypeDescription
Finding

getDescription()

public String getDescription()

Output only. The description of the vulnerability.

string description = 6;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. The description of the vulnerability.

string description = 6;

Returns
TypeDescription
ByteString

The bytes for description.

getFinalUrl()

public String getFinalUrl()

Output only. The URL where the browser lands when the vulnerability is detected.

string final_url = 9;

Returns
TypeDescription
String

The finalUrl.

getFinalUrlBytes()

public ByteString getFinalUrlBytes()

Output only. The URL where the browser lands when the vulnerability is detected.

string final_url = 9;

Returns
TypeDescription
ByteString

The bytes for finalUrl.

getFindingType()

public String getFindingType()

Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings

string finding_type = 2;

Returns
TypeDescription
String

The findingType.

getFindingTypeBytes()

public ByteString getFindingTypeBytes()

Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings

string finding_type = 2;

Returns
TypeDescription
ByteString

The bytes for findingType.

getForm()

public Form getForm()

Output only. An addon containing information reported for a vulnerability with an HTML form, if any.

.google.cloud.websecurityscanner.v1.Form form = 16;

Returns
TypeDescription
Form

The form.

getFormOrBuilder()

public FormOrBuilder getFormOrBuilder()

Output only. An addon containing information reported for a vulnerability with an HTML form, if any.

.google.cloud.websecurityscanner.v1.Form form = 16;

Returns
TypeDescription
FormOrBuilder

getFrameUrl()

public String getFrameUrl()

Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.

string frame_url = 8;

Returns
TypeDescription
String

The frameUrl.

getFrameUrlBytes()

public ByteString getFrameUrlBytes()

Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.

string frame_url = 8;

Returns
TypeDescription
ByteString

The bytes for frameUrl.

getFuzzedUrl()

public String getFuzzedUrl()

Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.

string fuzzed_url = 4;

Returns
TypeDescription
String

The fuzzedUrl.

getFuzzedUrlBytes()

public ByteString getFuzzedUrlBytes()

Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.

string fuzzed_url = 4;

Returns
TypeDescription
ByteString

The bytes for fuzzedUrl.

getHttpMethod()

public String getHttpMethod()

Output only. The http method of the request that triggered the vulnerability, in uppercase.

string http_method = 3;

Returns
TypeDescription
String

The httpMethod.

getHttpMethodBytes()

public ByteString getHttpMethodBytes()

Output only. The http method of the request that triggered the vulnerability, in uppercase.

string http_method = 3;

Returns
TypeDescription
ByteString

The bytes for httpMethod.

getName()

public String getName()

Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getOutdatedLibrary()

public OutdatedLibrary getOutdatedLibrary()

Output only. An addon containing information about outdated libraries.

.google.cloud.websecurityscanner.v1.OutdatedLibrary outdated_library = 11;

Returns
TypeDescription
OutdatedLibrary

The outdatedLibrary.

getOutdatedLibraryOrBuilder()

public OutdatedLibraryOrBuilder getOutdatedLibraryOrBuilder()

Output only. An addon containing information about outdated libraries.

.google.cloud.websecurityscanner.v1.OutdatedLibrary outdated_library = 11;

Returns
TypeDescription
OutdatedLibraryOrBuilder

getParserForType()

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

getReproductionUrl()

public String getReproductionUrl()

Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability.

string reproduction_url = 7;

Returns
TypeDescription
String

The reproductionUrl.

getReproductionUrlBytes()

public ByteString getReproductionUrlBytes()

Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability.

string reproduction_url = 7;

Returns
TypeDescription
ByteString

The bytes for reproductionUrl.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSeverity()

public Finding.Severity getSeverity()

Output only. The severity level of the reported vulnerability.

.google.cloud.websecurityscanner.v1.Finding.Severity severity = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Finding.Severity

The severity.

getSeverityValue()

public int getSeverityValue()

Output only. The severity level of the reported vulnerability.

.google.cloud.websecurityscanner.v1.Finding.Severity severity = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for severity.

getTrackingId()

public String getTrackingId()

Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.

string tracking_id = 10;

Returns
TypeDescription
String

The trackingId.

getTrackingIdBytes()

public ByteString getTrackingIdBytes()

Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.

string tracking_id = 10;

Returns
TypeDescription
ByteString

The bytes for trackingId.

getViolatingResource()

public ViolatingResource getViolatingResource()

Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

.google.cloud.websecurityscanner.v1.ViolatingResource violating_resource = 12;

Returns
TypeDescription
ViolatingResource

The violatingResource.

getViolatingResourceOrBuilder()

public ViolatingResourceOrBuilder getViolatingResourceOrBuilder()

Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

.google.cloud.websecurityscanner.v1.ViolatingResource violating_resource = 12;

Returns
TypeDescription
ViolatingResourceOrBuilder

getVulnerableHeaders()

public VulnerableHeaders getVulnerableHeaders()

Output only. An addon containing information about vulnerable or missing HTTP headers.

.google.cloud.websecurityscanner.v1.VulnerableHeaders vulnerable_headers = 15;

Returns
TypeDescription
VulnerableHeaders

The vulnerableHeaders.

getVulnerableHeadersOrBuilder()

public VulnerableHeadersOrBuilder getVulnerableHeadersOrBuilder()

Output only. An addon containing information about vulnerable or missing HTTP headers.

.google.cloud.websecurityscanner.v1.VulnerableHeaders vulnerable_headers = 15;

Returns
TypeDescription
VulnerableHeadersOrBuilder

getVulnerableParameters()

public VulnerableParameters getVulnerableParameters()

Output only. An addon containing information about request parameters which were found to be vulnerable.

.google.cloud.websecurityscanner.v1.VulnerableParameters vulnerable_parameters = 13;

Returns
TypeDescription
VulnerableParameters

The vulnerableParameters.

getVulnerableParametersOrBuilder()

public VulnerableParametersOrBuilder getVulnerableParametersOrBuilder()

Output only. An addon containing information about request parameters which were found to be vulnerable.

.google.cloud.websecurityscanner.v1.VulnerableParameters vulnerable_parameters = 13;

Returns
TypeDescription
VulnerableParametersOrBuilder

getXss()

public Xss getXss()

Output only. An addon containing information reported for an XSS, if any.

.google.cloud.websecurityscanner.v1.Xss xss = 14;

Returns
TypeDescription
Xss

The xss.

getXssOrBuilder()

public XssOrBuilder getXssOrBuilder()

Output only. An addon containing information reported for an XSS, if any.

.google.cloud.websecurityscanner.v1.Xss xss = 14;

Returns
TypeDescription
XssOrBuilder

getXxe()

public Xxe getXxe()

Output only. An addon containing information reported for an XXE, if any.

.google.cloud.websecurityscanner.v1.Xxe xxe = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Xxe

The xxe.

getXxeOrBuilder()

public XxeOrBuilder getXxeOrBuilder()

Output only. An addon containing information reported for an XXE, if any.

.google.cloud.websecurityscanner.v1.Xxe xxe = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
XxeOrBuilder

hasForm()

public boolean hasForm()

Output only. An addon containing information reported for a vulnerability with an HTML form, if any.

.google.cloud.websecurityscanner.v1.Form form = 16;

Returns
TypeDescription
boolean

Whether the form field is set.

hasOutdatedLibrary()

public boolean hasOutdatedLibrary()

Output only. An addon containing information about outdated libraries.

.google.cloud.websecurityscanner.v1.OutdatedLibrary outdated_library = 11;

Returns
TypeDescription
boolean

Whether the outdatedLibrary field is set.

hasViolatingResource()

public boolean hasViolatingResource()

Output only. An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

.google.cloud.websecurityscanner.v1.ViolatingResource violating_resource = 12;

Returns
TypeDescription
boolean

Whether the violatingResource field is set.

hasVulnerableHeaders()

public boolean hasVulnerableHeaders()

Output only. An addon containing information about vulnerable or missing HTTP headers.

.google.cloud.websecurityscanner.v1.VulnerableHeaders vulnerable_headers = 15;

Returns
TypeDescription
boolean

Whether the vulnerableHeaders field is set.

hasVulnerableParameters()

public boolean hasVulnerableParameters()

Output only. An addon containing information about request parameters which were found to be vulnerable.

.google.cloud.websecurityscanner.v1.VulnerableParameters vulnerable_parameters = 13;

Returns
TypeDescription
boolean

Whether the vulnerableParameters field is set.

hasXss()

public boolean hasXss()

Output only. An addon containing information reported for an XSS, if any.

.google.cloud.websecurityscanner.v1.Xss xss = 14;

Returns
TypeDescription
boolean

Whether the xss field is set.

hasXxe()

public boolean hasXxe()

Output only. An addon containing information reported for an XXE, if any.

.google.cloud.websecurityscanner.v1.Xxe xxe = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the xxe field is set.

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 Finding.Builder newBuilderForType()
Returns
TypeDescription
Finding.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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