Represents a ScanConfig.
Package
@google-cloud/web-security-scannerConstructors
(constructor)(properties)
constructor(properties?: google.cloud.websecurityscanner.v1alpha.IScanConfig);Constructs a new ScanConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IScanConfig
Properties to set |
Properties
authentication
public authentication?: (google.cloud.websecurityscanner.v1alpha.ScanConfig.IAuthentication|null);ScanConfig authentication.
blacklistPatterns
public blacklistPatterns: string[];ScanConfig blacklistPatterns.
displayName
public displayName: string;ScanConfig displayName.
latestRun
public latestRun?: (google.cloud.websecurityscanner.v1alpha.IScanRun|null);ScanConfig latestRun.
maxQps
public maxQps: number;ScanConfig maxQps.
name
public name: string;ScanConfig name.
schedule
public schedule?: (google.cloud.websecurityscanner.v1alpha.ScanConfig.ISchedule|null);ScanConfig schedule.
startingUrls
public startingUrls: string[];ScanConfig startingUrls.
targetPlatforms
public targetPlatforms: google.cloud.websecurityscanner.v1alpha.ScanConfig.TargetPlatform[];ScanConfig targetPlatforms.
userAgent
public userAgent: (google.cloud.websecurityscanner.v1alpha.ScanConfig.UserAgent|keyof typeof google.cloud.websecurityscanner.v1alpha.ScanConfig.UserAgent);ScanConfig userAgent.
Methods
create(properties)
public static create(properties?: google.cloud.websecurityscanner.v1alpha.IScanConfig): google.cloud.websecurityscanner.v1alpha.ScanConfig;Creates a new ScanConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IScanConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.websecurityscanner.v1alpha.ScanConfig | ScanConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.websecurityscanner.v1alpha.ScanConfig;Decodes a ScanConfig 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.ScanConfig | ScanConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.websecurityscanner.v1alpha.ScanConfig;Decodes a ScanConfig 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.ScanConfig | ScanConfig |
encode(message, writer)
public static encode(message: google.cloud.websecurityscanner.v1alpha.IScanConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ScanConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IScanConfig
ScanConfig 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.IScanConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified ScanConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IScanConfig
ScanConfig 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.ScanConfig;Creates a ScanConfig 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.ScanConfig | ScanConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for ScanConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this ScanConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.websecurityscanner.v1alpha.ScanConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a ScanConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.websecurityscanner.v1alpha.ScanConfig
ScanConfig |
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 ScanConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|