Constructor
new ScanConfig(propertiesopt)
Constructs a new ScanConfig.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.websecurityscanner.v1.IScanConfig |
<optional> |
Properties to set |
- Implements:
-
- IScanConfig
Classes
Members
authentication
ScanConfig authentication.
blacklistPatterns
ScanConfig blacklistPatterns.
displayName
ScanConfig displayName.
exportToSecurityCommandCenter
ScanConfig exportToSecurityCommandCenter.
ignoreHttpStatusErrors
ScanConfig ignoreHttpStatusErrors.
managedScan
ScanConfig managedScan.
maxQps
ScanConfig maxQps.
name
ScanConfig name.
riskLevel
ScanConfig riskLevel.
schedule
ScanConfig schedule.
startingUrls
ScanConfig startingUrls.
staticIpScan
ScanConfig staticIpScan.
userAgent
ScanConfig userAgent.
ExportToSecurityCommandCenter
ExportToSecurityCommandCenter enum.
Properties:
| Name | Type | Description |
|---|---|---|
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED |
number |
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED value |
ENABLED |
number |
ENABLED value |
DISABLED |
number |
DISABLED value |
RiskLevel
RiskLevel enum.
Properties:
| Name | Type | Description |
|---|---|---|
RISK_LEVEL_UNSPECIFIED |
number |
RISK_LEVEL_UNSPECIFIED value |
NORMAL |
number |
NORMAL value |
LOW |
number |
LOW value |
UserAgent
UserAgent enum.
Properties:
| Name | Type | Description |
|---|---|---|
USER_AGENT_UNSPECIFIED |
number |
USER_AGENT_UNSPECIFIED value |
CHROME_LINUX |
number |
CHROME_LINUX value |
CHROME_ANDROID |
number |
CHROME_ANDROID value |
SAFARI_IPHONE |
number |
SAFARI_IPHONE value |
Methods
toJSON() → {Object.<string, *>}
Converts this ScanConfig to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.websecurityscanner.v1.ScanConfig}
Creates a new ScanConfig instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.websecurityscanner.v1.IScanConfig |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.websecurityscanner.v1.ScanConfig |
ScanConfig instance |
(static) decode(reader, lengthopt) → {google.cloud.websecurityscanner.v1.ScanConfig}
Decodes a ScanConfig message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.websecurityscanner.v1.ScanConfig |
ScanConfig |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.websecurityscanner.v1.ScanConfig}
Decodes a ScanConfig message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.websecurityscanner.v1.ScanConfig |
ScanConfig |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified ScanConfig message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.websecurityscanner.v1.IScanConfig |
ScanConfig message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified ScanConfig message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.websecurityscanner.v1.IScanConfig |
ScanConfig message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.websecurityscanner.v1.ScanConfig}
Creates a ScanConfig message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.websecurityscanner.v1.ScanConfig |
ScanConfig |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for ScanConfig
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a ScanConfig message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.websecurityscanner.v1.ScanConfig |
ScanConfig |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a ScanConfig message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|