Class protos.google.cloud.websecurityscanner.v1beta.ScanRun

Represents a ScanRun.

Package

@google-cloud/web-security-scanner

Constructors

(constructor)(properties)

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

Constructs a new ScanRun.

Parameter
NameDescription
properties IScanRun

Properties to set

Properties

endTime

public endTime?: (google.protobuf.ITimestamp|null);

ScanRun endTime.

errorTrace

public errorTrace?: (google.cloud.websecurityscanner.v1beta.IScanRunErrorTrace|null);

ScanRun errorTrace.

executionState

public executionState: (google.cloud.websecurityscanner.v1beta.ScanRun.ExecutionState|keyof typeof google.cloud.websecurityscanner.v1beta.ScanRun.ExecutionState);

ScanRun executionState.

hasVulnerabilities

public hasVulnerabilities: boolean;

ScanRun hasVulnerabilities.

name

public name: string;

ScanRun name.

progressPercent

public progressPercent: number;

ScanRun progressPercent.

resultState

public resultState: (google.cloud.websecurityscanner.v1beta.ScanRun.ResultState|keyof typeof google.cloud.websecurityscanner.v1beta.ScanRun.ResultState);

ScanRun resultState.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

ScanRun startTime.

urlsCrawledCount

public urlsCrawledCount: (number|Long|string);

ScanRun urlsCrawledCount.

urlsTestedCount

public urlsTestedCount: (number|Long|string);

ScanRun urlsTestedCount.

warningTraces

public warningTraces: google.cloud.websecurityscanner.v1beta.IScanRunWarningTrace[];

ScanRun warningTraces.

Methods

create(properties)

public static create(properties?: google.cloud.websecurityscanner.v1beta.IScanRun): google.cloud.websecurityscanner.v1beta.ScanRun;

Creates a new ScanRun instance using the specified properties.

Parameter
NameDescription
properties IScanRun

Properties to set

Returns
TypeDescription
google.cloud.websecurityscanner.v1beta.ScanRun

ScanRun instance

decode(reader, length)

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

Decodes a ScanRun 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.v1beta.ScanRun

ScanRun

decodeDelimited(reader)

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

Decodes a ScanRun 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.v1beta.ScanRun

ScanRun

encode(message, writer)

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

Encodes the specified ScanRun message. Does not implicitly messages.

Parameters
NameDescription
message IScanRun

ScanRun 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.IScanRun, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IScanRun

ScanRun 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.ScanRun;

Creates a ScanRun 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.v1beta.ScanRun

ScanRun

toJSON()

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

Converts this ScanRun to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.websecurityscanner.v1beta.ScanRun

ScanRun

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