Constructor
new WebSecurityScanner(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new WebSecurityScanner service.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
createScanConfig(request, callback) → {undefined}
Calls CreateScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest |
CreateScanConfigRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.CreateScanConfigCallback |
Node-style callback called with the error, if any, and ScanConfig |
Returns:
Type | Description |
---|---|
undefined |
createScanConfig(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ScanConfig>}
Calls CreateScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest |
CreateScanConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ScanConfig> |
Promise |
deleteScanConfig(request, callback) → {undefined}
Calls DeleteScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest |
DeleteScanConfigRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.DeleteScanConfigCallback |
Node-style callback called with the error, if any, and Empty |
Returns:
Type | Description |
---|---|
undefined |
deleteScanConfig(request) → {Promise.<google.protobuf.Empty>}
Calls DeleteScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest |
DeleteScanConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.protobuf.Empty> |
Promise |
getFinding(request, callback) → {undefined}
Calls GetFinding.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IGetFindingRequest |
GetFindingRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.GetFindingCallback |
Node-style callback called with the error, if any, and Finding |
Returns:
Type | Description |
---|---|
undefined |
getFinding(request) → {Promise.<google.cloud.websecurityscanner.v1beta.Finding>}
Calls GetFinding.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IGetFindingRequest |
GetFindingRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.Finding> |
Promise |
getScanConfig(request, callback) → {undefined}
Calls GetScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest |
GetScanConfigRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.GetScanConfigCallback |
Node-style callback called with the error, if any, and ScanConfig |
Returns:
Type | Description |
---|---|
undefined |
getScanConfig(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ScanConfig>}
Calls GetScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest |
GetScanConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ScanConfig> |
Promise |
getScanRun(request, callback) → {undefined}
Calls GetScanRun.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IGetScanRunRequest |
GetScanRunRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.GetScanRunCallback |
Node-style callback called with the error, if any, and ScanRun |
Returns:
Type | Description |
---|---|
undefined |
getScanRun(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ScanRun>}
Calls GetScanRun.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IGetScanRunRequest |
GetScanRunRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ScanRun> |
Promise |
listCrawledUrls(request, callback) → {undefined}
Calls ListCrawledUrls.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest |
ListCrawledUrlsRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.ListCrawledUrlsCallback |
Node-style callback called with the error, if any, and ListCrawledUrlsResponse |
Returns:
Type | Description |
---|---|
undefined |
listCrawledUrls(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ListCrawledUrlsResponse>}
Calls ListCrawledUrls.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest |
ListCrawledUrlsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ListCrawledUrlsResponse> |
Promise |
listFindingTypeStats(request, callback) → {undefined}
Calls ListFindingTypeStats.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest |
ListFindingTypeStatsRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.ListFindingTypeStatsCallback |
Node-style callback called with the error, if any, and ListFindingTypeStatsResponse |
Returns:
Type | Description |
---|---|
undefined |
listFindingTypeStats(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsResponse>}
Calls ListFindingTypeStats.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest |
ListFindingTypeStatsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsResponse> |
Promise |
listFindings(request, callback) → {undefined}
Calls ListFindings.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListFindingsRequest |
ListFindingsRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.ListFindingsCallback |
Node-style callback called with the error, if any, and ListFindingsResponse |
Returns:
Type | Description |
---|---|
undefined |
listFindings(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ListFindingsResponse>}
Calls ListFindings.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListFindingsRequest |
ListFindingsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ListFindingsResponse> |
Promise |
listScanConfigs(request, callback) → {undefined}
Calls ListScanConfigs.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest |
ListScanConfigsRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.ListScanConfigsCallback |
Node-style callback called with the error, if any, and ListScanConfigsResponse |
Returns:
Type | Description |
---|---|
undefined |
listScanConfigs(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ListScanConfigsResponse>}
Calls ListScanConfigs.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest |
ListScanConfigsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ListScanConfigsResponse> |
Promise |
listScanRuns(request, callback) → {undefined}
Calls ListScanRuns.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListScanRunsRequest |
ListScanRunsRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.ListScanRunsCallback |
Node-style callback called with the error, if any, and ListScanRunsResponse |
Returns:
Type | Description |
---|---|
undefined |
listScanRuns(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ListScanRunsResponse>}
Calls ListScanRuns.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IListScanRunsRequest |
ListScanRunsRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ListScanRunsResponse> |
Promise |
startScanRun(request, callback) → {undefined}
Calls StartScanRun.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IStartScanRunRequest |
StartScanRunRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.StartScanRunCallback |
Node-style callback called with the error, if any, and ScanRun |
Returns:
Type | Description |
---|---|
undefined |
startScanRun(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ScanRun>}
Calls StartScanRun.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IStartScanRunRequest |
StartScanRunRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ScanRun> |
Promise |
stopScanRun(request, callback) → {undefined}
Calls StopScanRun.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IStopScanRunRequest |
StopScanRunRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.StopScanRunCallback |
Node-style callback called with the error, if any, and ScanRun |
Returns:
Type | Description |
---|---|
undefined |
stopScanRun(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ScanRun>}
Calls StopScanRun.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IStopScanRunRequest |
StopScanRunRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ScanRun> |
Promise |
updateScanConfig(request, callback) → {undefined}
Calls UpdateScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest |
UpdateScanConfigRequest message or plain object |
callback |
google.cloud.websecurityscanner.v1beta.WebSecurityScanner.UpdateScanConfigCallback |
Node-style callback called with the error, if any, and ScanConfig |
Returns:
Type | Description |
---|---|
undefined |
updateScanConfig(request) → {Promise.<google.cloud.websecurityscanner.v1beta.ScanConfig>}
Calls UpdateScanConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest |
UpdateScanConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.websecurityscanner.v1beta.ScanConfig> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {WebSecurityScanner}
Creates new WebSecurityScanner service using the specified rpc implementation.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
Type | Description |
---|---|
WebSecurityScanner |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
CreateScanConfigCallback(error, responseopt)
Callback as used by createScanConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ScanConfig |
<optional> |
ScanConfig |
DeleteScanConfigCallback(error, responseopt)
Callback as used by deleteScanConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.protobuf.Empty |
<optional> |
Empty |
GetFindingCallback(error, responseopt)
Callback as used by getFinding.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.Finding |
<optional> |
Finding |
GetScanConfigCallback(error, responseopt)
Callback as used by getScanConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ScanConfig |
<optional> |
ScanConfig |
GetScanRunCallback(error, responseopt)
Callback as used by getScanRun.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ScanRun |
<optional> |
ScanRun |
ListCrawledUrlsCallback(error, responseopt)
Callback as used by listCrawledUrls.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ListCrawledUrlsResponse |
<optional> |
ListCrawledUrlsResponse |
ListFindingTypeStatsCallback(error, responseopt)
Callback as used by listFindingTypeStats.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsResponse |
<optional> |
ListFindingTypeStatsResponse |
ListFindingsCallback(error, responseopt)
Callback as used by listFindings.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ListFindingsResponse |
<optional> |
ListFindingsResponse |
ListScanConfigsCallback(error, responseopt)
Callback as used by listScanConfigs.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ListScanConfigsResponse |
<optional> |
ListScanConfigsResponse |
ListScanRunsCallback(error, responseopt)
Callback as used by listScanRuns.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ListScanRunsResponse |
<optional> |
ListScanRunsResponse |
StartScanRunCallback(error, responseopt)
Callback as used by startScanRun.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ScanRun |
<optional> |
ScanRun |
StopScanRunCallback(error, responseopt)
Callback as used by stopScanRun.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ScanRun |
<optional> |
ScanRun |
UpdateScanConfigCallback(error, responseopt)
Callback as used by updateScanConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.websecurityscanner.v1beta.ScanConfig |
<optional> |
ScanConfig |