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

Represents a ScanRun.

Package

@google-cloud/web-security-scanner!

Constructors

(constructor)(properties)

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

Constructs a new ScanRun.

Parameter

Name	Description
properties	`IScanRun` Properties to set

Properties

endTime

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

ScanRun endTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

errorTrace

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

ScanRun errorTrace.

Property Value

Type	Description
(google.cloud.websecurityscanner.v1.IScanRunErrorTrace\|null)

executionState

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

ScanRun executionState.

Property Value

Type	Description
(google.cloud.websecurityscanner.v1.ScanRun.ExecutionState\|keyof typeof google.cloud.websecurityscanner.v1.ScanRun.ExecutionState)

hasVulnerabilities

public hasVulnerabilities: boolean;

ScanRun hasVulnerabilities.

Property Value

Type	Description
boolean

name

public name: string;

ScanRun name.

Property Value

Type	Description
string

progressPercent

public progressPercent: number;

ScanRun progressPercent.

Property Value

Type	Description
number

resultState

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

ScanRun resultState.

Property Value

Type	Description
(google.cloud.websecurityscanner.v1.ScanRun.ResultState\|keyof typeof google.cloud.websecurityscanner.v1.ScanRun.ResultState)

startTime

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

ScanRun startTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

urlsCrawledCount

public urlsCrawledCount: (number|Long|string);

ScanRun urlsCrawledCount.

Property Value

Type	Description
(number\|Long\|string)

urlsTestedCount

public urlsTestedCount: (number|Long|string);

ScanRun urlsTestedCount.

Property Value

Type	Description
(number\|Long\|string)

warningTraces

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

ScanRun warningTraces.

Property Value

Type	Description
google.cloud.websecurityscanner.v1.IScanRunWarningTrace[]

Methods

create(properties)

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

Creates a new ScanRun instance using the specified properties.

Parameter

Name	Description
properties	`IScanRun` Properties to set

Returns

Type	Description
google.cloud.websecurityscanner.v1.ScanRun	ScanRun instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified ScanRun message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	`IScanRun` ScanRun 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.v1.ScanRun;

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

toJSON()

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

Converts this ScanRun to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.websecurityscanner.v1.ScanRun` ScanRun
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 ScanRun 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