Class protos.google.cloud.websecurityscanner.v1beta.Finding (3.0.2)

Represents a Finding.

Package

@google-cloud/web-security-scanner

Constructors

(constructor)(properties)

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

Constructs a new Finding.

Parameter
NameDescription
properties IFinding

Properties to set

Properties

body

public body: string;

Finding body.

description

public description: string;

Finding description.

finalUrl

public finalUrl: string;

Finding finalUrl.

findingType

public findingType: string;

Finding findingType.

form

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

Finding form.

frameUrl

public frameUrl: string;

Finding frameUrl.

fuzzedUrl

public fuzzedUrl: string;

Finding fuzzedUrl.

httpMethod

public httpMethod: string;

Finding httpMethod.

name

public name: string;

Finding name.

outdatedLibrary

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

Finding outdatedLibrary.

reproductionUrl

public reproductionUrl: string;

Finding reproductionUrl.

trackingId

public trackingId: string;

Finding trackingId.

violatingResource

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

Finding violatingResource.

vulnerableHeaders

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

Finding vulnerableHeaders.

vulnerableParameters

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

Finding vulnerableParameters.

xss

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

Finding xss.

Methods

create(properties)

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

Creates a new Finding instance using the specified properties.

Parameter
NameDescription
properties IFinding

Properties to set

Returns
TypeDescription
Finding

Finding instance

decode(reader, length)

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

Decodes a Finding message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Finding

Finding

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Finding

Finding

encode(message, writer)

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

Encodes the specified Finding message. Does not implicitly messages.

Parameters
NameDescription
message IFinding

Finding message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IFinding

Finding message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
Finding

Finding

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Finding

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

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.v1beta.Finding, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message Finding

Finding

options $protobuf.IConversionOptions

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
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not