Class protos.google.cloud.websecurityscanner.v1.Finding

Represents a Finding.

Package

@google-cloud/web-security-scanner!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.websecurityscanner.v1.IFinding);

Constructs a new Finding.

Parameter
TypeNameDescription
IFindingproperties

Properties to set

Properties

body

public body: string;

Finding body.

Property Value
TypeDescription
string

description

public description: string;

Finding description.

Property Value
TypeDescription
string

finalUrl

public finalUrl: string;

Finding finalUrl.

Property Value
TypeDescription
string

findingType

public findingType: string;

Finding findingType.

Property Value
TypeDescription
string

form

public form?: (google.cloud.websecurityscanner.v1.IForm|null);

Finding form.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.IForm|null)

frameUrl

public frameUrl: string;

Finding frameUrl.

Property Value
TypeDescription
string

fuzzedUrl

public fuzzedUrl: string;

Finding fuzzedUrl.

Property Value
TypeDescription
string

httpMethod

public httpMethod: string;

Finding httpMethod.

Property Value
TypeDescription
string

name

public name: string;

Finding name.

Property Value
TypeDescription
string

outdatedLibrary

public outdatedLibrary?: (google.cloud.websecurityscanner.v1.IOutdatedLibrary|null);

Finding outdatedLibrary.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.IOutdatedLibrary|null)

reproductionUrl

public reproductionUrl: string;

Finding reproductionUrl.

Property Value
TypeDescription
string

severity

public severity: (google.cloud.websecurityscanner.v1.Finding.Severity|keyof typeof google.cloud.websecurityscanner.v1.Finding.Severity);

Finding severity.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.Finding.Severity|keyof typeof google.cloud.websecurityscanner.v1.Finding.Severity)

trackingId

public trackingId: string;

Finding trackingId.

Property Value
TypeDescription
string

violatingResource

public violatingResource?: (google.cloud.websecurityscanner.v1.IViolatingResource|null);

Finding violatingResource.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.IViolatingResource|null)

vulnerableHeaders

public vulnerableHeaders?: (google.cloud.websecurityscanner.v1.IVulnerableHeaders|null);

Finding vulnerableHeaders.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.IVulnerableHeaders|null)

vulnerableParameters

public vulnerableParameters?: (google.cloud.websecurityscanner.v1.IVulnerableParameters|null);

Finding vulnerableParameters.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.IVulnerableParameters|null)

xss

public xss?: (google.cloud.websecurityscanner.v1.IXss|null);

Finding xss.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.IXss|null)

Methods

create(properties)

public static create(properties?: google.cloud.websecurityscanner.v1.IFinding): google.cloud.websecurityscanner.v1.Finding;

Creates a new Finding instance using the specified properties.

Parameter
TypeNameDescription
IFindingproperties

Properties to set

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Finding

Finding instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.websecurityscanner.v1.Finding;

Decodes a Finding message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Finding

Finding

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.websecurityscanner.v1.Finding;

Decodes a Finding message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Finding

Finding

encode(message, writer)

public static encode(message: google.cloud.websecurityscanner.v1.IFinding, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Finding message. Does not implicitly messages.

Parameters
TypeNameDescription
IFindingmessage

Finding message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.websecurityscanner.v1.IFinding, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Finding message, length delimited. Does not implicitly messages.

Parameters
TypeNameDescription
IFindingmessage

Finding message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.websecurityscanner.v1.Finding;

Creates a Finding message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Finding

Finding

toJSON()

public toJSON(): { [k: string]: any };

Converts this Finding to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.websecurityscanner.v1.Finding, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Finding message. Also converts values to other types if specified.

Parameters
TypeNameDescription
google.cloud.websecurityscanner.v1.Findingmessage

Finding

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Finding message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not