Class protos.google.cloud.websecurityscanner.v1.Xss (1.0.7)

Represents a Xss.

Package

@google-cloud/web-security-scanner!

Constructors

(constructor)(properties)

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

Constructs a new Xss.

Parameter
NameDescription
properties IXss

Properties to set

Properties

attackVector

public attackVector: (google.cloud.websecurityscanner.v1.Xss.AttackVector|keyof typeof google.cloud.websecurityscanner.v1.Xss.AttackVector);

Xss attackVector.

Property Value
TypeDescription
(google.cloud.websecurityscanner.v1.Xss.AttackVector|keyof typeof google.cloud.websecurityscanner.v1.Xss.AttackVector)

errorMessage

public errorMessage: string;

Xss errorMessage.

Property Value
TypeDescription
string

stackTraces

public stackTraces: string[];

Xss stackTraces.

Property Value
TypeDescription
string[]

storedXssSeedingUrl

public storedXssSeedingUrl: string;

Xss storedXssSeedingUrl.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.cloud.websecurityscanner.v1.IXss): google.cloud.websecurityscanner.v1.Xss;

Creates a new Xss instance using the specified properties.

Parameter
NameDescription
properties IXss

Properties to set

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Xss

Xss instance

decode(reader, length)

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

Decodes a Xss message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Xss

Xss

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Xss

Xss

encode(message, writer)

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

Encodes the specified Xss message. Does not implicitly messages.

Parameters
NameDescription
message IXss

Xss 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.v1.IXss, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IXss

Xss 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.v1.Xss;

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

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

Plain object

Returns
TypeDescription
google.cloud.websecurityscanner.v1.Xss

Xss

toJSON()

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

Converts this Xss to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.websecurityscanner.v1.Xss

Xss

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 Xss 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