Class protos.google.cloud.websecurityscanner.v1.ScanConfig

Represents a ScanConfig.

Package

@google-cloud/web-security-scanner

Constructors

(constructor)(properties)

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

Constructs a new ScanConfig.

Parameter
NameDescription
properties IScanConfig

Properties to set

Properties

authentication

public authentication?: (google.cloud.websecurityscanner.v1.ScanConfig.IAuthentication|null);

ScanConfig authentication.

blacklistPatterns

public blacklistPatterns: string[];

ScanConfig blacklistPatterns.

displayName

public displayName: string;

ScanConfig displayName.

exportToSecurityCommandCenter

public exportToSecurityCommandCenter: (google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter|keyof typeof google.cloud.websecurityscanner.v1.ScanConfig.ExportToSecurityCommandCenter);

ScanConfig exportToSecurityCommandCenter.

managedScan

public managedScan: boolean;

ScanConfig managedScan.

maxQps

public maxQps: number;

ScanConfig maxQps.

name

public name: string;

ScanConfig name.

riskLevel

public riskLevel: (google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel|keyof typeof google.cloud.websecurityscanner.v1.ScanConfig.RiskLevel);

ScanConfig riskLevel.

schedule

public schedule?: (google.cloud.websecurityscanner.v1.ScanConfig.ISchedule|null);

ScanConfig schedule.

startingUrls

public startingUrls: string[];

ScanConfig startingUrls.

staticIpScan

public staticIpScan: boolean;

ScanConfig staticIpScan.

userAgent

public userAgent: (google.cloud.websecurityscanner.v1.ScanConfig.UserAgent|keyof typeof google.cloud.websecurityscanner.v1.ScanConfig.UserAgent);

ScanConfig userAgent.

Methods

create(properties)

public static create(properties?: google.cloud.websecurityscanner.v1.IScanConfig): google.cloud.websecurityscanner.v1.ScanConfig;

Creates a new ScanConfig instance using the specified properties.

Parameter
NameDescription
properties IScanConfig

Properties to set

Returns
TypeDescription
google.cloud.websecurityscanner.v1.ScanConfig

ScanConfig instance

decode(reader, length)

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

Decodes a ScanConfig 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.ScanConfig

ScanConfig

decodeDelimited(reader)

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

Decodes a ScanConfig 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.ScanConfig

ScanConfig

encode(message, writer)

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

Encodes the specified ScanConfig message. Does not implicitly messages.

Parameters
NameDescription
message IScanConfig

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

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

Parameters
NameDescription
message IScanConfig

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

Creates a ScanConfig 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.ScanConfig

ScanConfig

toJSON()

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

Converts this ScanConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

ScanConfig

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