Class protos.google.cloud.websecurityscanner.v1alpha.Finding (1.1.1)

Represents a Finding.

Package

Constructors

(constructor)(properties)

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

Constructs a new Finding.

Parameter

Name	Description
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: (google.cloud.websecurityscanner.v1alpha.Finding.FindingType|keyof typeof google.cloud.websecurityscanner.v1alpha.Finding.FindingType);

Finding findingType.

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.v1alpha.IOutdatedLibrary|null);

Finding outdatedLibrary.

reproductionUrl

public reproductionUrl: string;

Finding reproductionUrl.

trackingId

public trackingId: string;

Finding trackingId.

violatingResource

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

Finding violatingResource.

vulnerableHeaders

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

Finding vulnerableHeaders.

vulnerableParameters

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

Finding vulnerableParameters.

xss

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

Finding xss.

Methods

create(properties)

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

Creates a new Finding instance using the specified properties.

Parameter

Name	Description
properties	`IFinding` Properties to set

Returns

Type	Description
google.cloud.websecurityscanner.v1alpha.Finding	Finding instance

decode(reader, length)

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

Decodes a Finding message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.websecurityscanner.v1alpha.Finding	Finding

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.websecurityscanner.v1alpha.Finding	Finding

encode(message, writer)

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

Encodes the specified Finding message. Does not implicitly messages.

Parameters

Name	Description
message	`IFinding` Finding message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Name	Description
message	`IFinding` Finding message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

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

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

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.websecurityscanner.v1alpha.Finding	Finding

toJSON()

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

Converts this Finding to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.websecurityscanner.v1alpha.Finding` Finding
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies a Finding message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not