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

Represents a WebSecurityScanner

Inheritance

$protobuf.rpc.Service > protos.google.cloud.websecurityscanner.v1.WebSecurityScanner

Package

@google-cloud/web-security-scanner!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new WebSecurityScanner service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): WebSecurityScanner;

Creates new WebSecurityScanner service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

Type	Description
WebSecurityScanner	RPC service. Useful where requests and/or responses are streamed.

createScanConfig(request, callback)

public createScanConfig(request: google.cloud.websecurityscanner.v1.ICreateScanConfigRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.CreateScanConfigCallback): void;

Calls CreateScanConfig.

Parameters

Name	Description
request	`ICreateScanConfigRequest` CreateScanConfigRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.CreateScanConfigCallback` Node-style callback called with the error, if any, and ScanConfig

Returns

Type	Description
void

createScanConfig(request)

public createScanConfig(request: google.cloud.websecurityscanner.v1.ICreateScanConfigRequest): Promise<google.cloud.websecurityscanner.v1.ScanConfig>;

Calls CreateScanConfig.

Parameter

Name	Description
request	`ICreateScanConfigRequest` CreateScanConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ScanConfig>	Promise

deleteScanConfig(request, callback)

public deleteScanConfig(request: google.cloud.websecurityscanner.v1.IDeleteScanConfigRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.DeleteScanConfigCallback): void;

Calls DeleteScanConfig.

Parameters

Name	Description
request	`IDeleteScanConfigRequest` DeleteScanConfigRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.DeleteScanConfigCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deleteScanConfig(request)

public deleteScanConfig(request: google.cloud.websecurityscanner.v1.IDeleteScanConfigRequest): Promise<google.protobuf.Empty>;

Calls DeleteScanConfig.

Parameter

Name	Description
request	`IDeleteScanConfigRequest` DeleteScanConfigRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

getFinding(request, callback)

public getFinding(request: google.cloud.websecurityscanner.v1.IGetFindingRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.GetFindingCallback): void;

Calls GetFinding.

Parameters

Name	Description
request	`IGetFindingRequest` GetFindingRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.GetFindingCallback` Node-style callback called with the error, if any, and Finding

Returns

Type	Description
void

getFinding(request)

public getFinding(request: google.cloud.websecurityscanner.v1.IGetFindingRequest): Promise<google.cloud.websecurityscanner.v1.Finding>;

Calls GetFinding.

Parameter

Name	Description
request	`IGetFindingRequest` GetFindingRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.Finding>	Promise

getScanConfig(request, callback)

public getScanConfig(request: google.cloud.websecurityscanner.v1.IGetScanConfigRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.GetScanConfigCallback): void;

Calls GetScanConfig.

Parameters

Name	Description
request	`IGetScanConfigRequest` GetScanConfigRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.GetScanConfigCallback` Node-style callback called with the error, if any, and ScanConfig

Returns

Type	Description
void

getScanConfig(request)

public getScanConfig(request: google.cloud.websecurityscanner.v1.IGetScanConfigRequest): Promise<google.cloud.websecurityscanner.v1.ScanConfig>;

Calls GetScanConfig.

Parameter

Name	Description
request	`IGetScanConfigRequest` GetScanConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ScanConfig>	Promise

getScanRun(request, callback)

public getScanRun(request: google.cloud.websecurityscanner.v1.IGetScanRunRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.GetScanRunCallback): void;

Calls GetScanRun.

Parameters

Name	Description
request	`IGetScanRunRequest` GetScanRunRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.GetScanRunCallback` Node-style callback called with the error, if any, and ScanRun

Returns

Type	Description
void

getScanRun(request)

public getScanRun(request: google.cloud.websecurityscanner.v1.IGetScanRunRequest): Promise<google.cloud.websecurityscanner.v1.ScanRun>;

Calls GetScanRun.

Parameter

Name	Description
request	`IGetScanRunRequest` GetScanRunRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ScanRun>	Promise

listCrawledUrls(request, callback)

public listCrawledUrls(request: google.cloud.websecurityscanner.v1.IListCrawledUrlsRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.ListCrawledUrlsCallback): void;

Calls ListCrawledUrls.

Parameters

Name	Description
request	`IListCrawledUrlsRequest` ListCrawledUrlsRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.ListCrawledUrlsCallback` Node-style callback called with the error, if any, and ListCrawledUrlsResponse

Returns

Type	Description
void

listCrawledUrls(request)

public listCrawledUrls(request: google.cloud.websecurityscanner.v1.IListCrawledUrlsRequest): Promise<google.cloud.websecurityscanner.v1.ListCrawledUrlsResponse>;

Calls ListCrawledUrls.

Parameter

Name	Description
request	`IListCrawledUrlsRequest` ListCrawledUrlsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ListCrawledUrlsResponse>	Promise

listFindings(request, callback)

public listFindings(request: google.cloud.websecurityscanner.v1.IListFindingsRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.ListFindingsCallback): void;

Calls ListFindings.

Parameters

Name	Description
request	`IListFindingsRequest` ListFindingsRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.ListFindingsCallback` Node-style callback called with the error, if any, and ListFindingsResponse

Returns

Type	Description
void

listFindings(request)

public listFindings(request: google.cloud.websecurityscanner.v1.IListFindingsRequest): Promise<google.cloud.websecurityscanner.v1.ListFindingsResponse>;

Calls ListFindings.

Parameter

Name	Description
request	`IListFindingsRequest` ListFindingsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ListFindingsResponse>	Promise

listFindingTypeStats(request, callback)

public listFindingTypeStats(request: google.cloud.websecurityscanner.v1.IListFindingTypeStatsRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.ListFindingTypeStatsCallback): void;

Calls ListFindingTypeStats.

Parameters

Name	Description
request	`IListFindingTypeStatsRequest` ListFindingTypeStatsRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.ListFindingTypeStatsCallback` Node-style callback called with the error, if any, and ListFindingTypeStatsResponse

Returns

Type	Description
void

listFindingTypeStats(request)

public listFindingTypeStats(request: google.cloud.websecurityscanner.v1.IListFindingTypeStatsRequest): Promise<google.cloud.websecurityscanner.v1.ListFindingTypeStatsResponse>;

Calls ListFindingTypeStats.

Parameter

Name	Description
request	`IListFindingTypeStatsRequest` ListFindingTypeStatsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ListFindingTypeStatsResponse>	Promise

listScanConfigs(request, callback)

public listScanConfigs(request: google.cloud.websecurityscanner.v1.IListScanConfigsRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.ListScanConfigsCallback): void;

Calls ListScanConfigs.

Parameters

Name	Description
request	`IListScanConfigsRequest` ListScanConfigsRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.ListScanConfigsCallback` Node-style callback called with the error, if any, and ListScanConfigsResponse

Returns

Type	Description
void

listScanConfigs(request)

public listScanConfigs(request: google.cloud.websecurityscanner.v1.IListScanConfigsRequest): Promise<google.cloud.websecurityscanner.v1.ListScanConfigsResponse>;

Calls ListScanConfigs.

Parameter

Name	Description
request	`IListScanConfigsRequest` ListScanConfigsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ListScanConfigsResponse>	Promise

listScanRuns(request, callback)

public listScanRuns(request: google.cloud.websecurityscanner.v1.IListScanRunsRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.ListScanRunsCallback): void;

Calls ListScanRuns.

Parameters

Name	Description
request	`IListScanRunsRequest` ListScanRunsRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.ListScanRunsCallback` Node-style callback called with the error, if any, and ListScanRunsResponse

Returns

Type	Description
void

listScanRuns(request)

public listScanRuns(request: google.cloud.websecurityscanner.v1.IListScanRunsRequest): Promise<google.cloud.websecurityscanner.v1.ListScanRunsResponse>;

Calls ListScanRuns.

Parameter

Name	Description
request	`IListScanRunsRequest` ListScanRunsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ListScanRunsResponse>	Promise

startScanRun(request, callback)

public startScanRun(request: google.cloud.websecurityscanner.v1.IStartScanRunRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.StartScanRunCallback): void;

Calls StartScanRun.

Parameters

Name	Description
request	`IStartScanRunRequest` StartScanRunRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.StartScanRunCallback` Node-style callback called with the error, if any, and ScanRun

Returns

Type	Description
void

startScanRun(request)

public startScanRun(request: google.cloud.websecurityscanner.v1.IStartScanRunRequest): Promise<google.cloud.websecurityscanner.v1.ScanRun>;

Calls StartScanRun.

Parameter

Name	Description
request	`IStartScanRunRequest` StartScanRunRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ScanRun>	Promise

stopScanRun(request, callback)

public stopScanRun(request: google.cloud.websecurityscanner.v1.IStopScanRunRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.StopScanRunCallback): void;

Calls StopScanRun.

Parameters

Name	Description
request	`IStopScanRunRequest` StopScanRunRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.StopScanRunCallback` Node-style callback called with the error, if any, and ScanRun

Returns

Type	Description
void

stopScanRun(request)

public stopScanRun(request: google.cloud.websecurityscanner.v1.IStopScanRunRequest): Promise<google.cloud.websecurityscanner.v1.ScanRun>;

Calls StopScanRun.

Parameter

Name	Description
request	`IStopScanRunRequest` StopScanRunRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ScanRun>	Promise

updateScanConfig(request, callback)

public updateScanConfig(request: google.cloud.websecurityscanner.v1.IUpdateScanConfigRequest, callback: google.cloud.websecurityscanner.v1.WebSecurityScanner.UpdateScanConfigCallback): void;

Calls UpdateScanConfig.

Parameters

Name	Description
request	`IUpdateScanConfigRequest` UpdateScanConfigRequest message or plain object
callback	`google.cloud.websecurityscanner.v1.WebSecurityScanner.UpdateScanConfigCallback` Node-style callback called with the error, if any, and ScanConfig

Returns

Type	Description
void

updateScanConfig(request)

public updateScanConfig(request: google.cloud.websecurityscanner.v1.IUpdateScanConfigRequest): Promise<google.cloud.websecurityscanner.v1.ScanConfig>;

Calls UpdateScanConfig.

Parameter

Name	Description
request	`IUpdateScanConfigRequest` UpdateScanConfigRequest message or plain object

Returns

Type	Description
Promise<google.cloud.websecurityscanner.v1.ScanConfig>	Promise