Web Security Scanner v1 API - Class WebSecurityScannerClientImpl (2.2.0)

public sealed class WebSecurityScannerClientImpl : WebSecurityScannerClient

Reference documentation and code samples for the Web Security Scanner v1 API class WebSecurityScannerClientImpl.

WebSecurityScanner client wrapper implementation, for convenient use.

Inheritance

Object > WebSecurityScannerClient > WebSecurityScannerClientImpl

Namespace

Google.Cloud.WebSecurityScanner.V1

Assembly

Google.Cloud.WebSecurityScanner.V1.dll

Remarks

Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

Constructors

WebSecurityScannerClientImpl(WebSecurityScanner.WebSecurityScannerClient, WebSecurityScannerSettings, ILogger)

public WebSecurityScannerClientImpl(WebSecurityScanner.WebSecurityScannerClient grpcClient, WebSecurityScannerSettings settings, ILogger logger)

Constructs a client wrapper for the WebSecurityScanner service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientWebSecurityScanner.WebSecurityScannerClient

The underlying gRPC client.

settingsWebSecurityScannerSettings

The base WebSecurityScannerSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override WebSecurityScanner.WebSecurityScannerClient GrpcClient { get; }

The underlying gRPC WebSecurityScanner client

Property Value
TypeDescription
WebSecurityScanner.WebSecurityScannerClient
Overrides

Methods

CreateScanConfig(CreateScanConfigRequest, CallSettings)

public override ScanConfig CreateScanConfig(CreateScanConfigRequest request, CallSettings callSettings = null)

Creates a new ScanConfig.

Parameters
NameDescription
requestCreateScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScanConfig

The RPC response.

Overrides

CreateScanConfigAsync(CreateScanConfigRequest, CallSettings)

public override Task<ScanConfig> CreateScanConfigAsync(CreateScanConfigRequest request, CallSettings callSettings = null)

Creates a new ScanConfig.

Parameters
NameDescription
requestCreateScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScanConfig>

A Task containing the RPC response.

Overrides

DeleteScanConfig(DeleteScanConfigRequest, CallSettings)

public override void DeleteScanConfig(DeleteScanConfigRequest request, CallSettings callSettings = null)

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
requestDeleteScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteScanConfigAsync(DeleteScanConfigRequest, CallSettings)

public override Task DeleteScanConfigAsync(DeleteScanConfigRequest request, CallSettings callSettings = null)

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
requestDeleteScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetFinding(GetFindingRequest, CallSettings)

public override Finding GetFinding(GetFindingRequest request, CallSettings callSettings = null)

Gets a Finding.

Parameters
NameDescription
requestGetFindingRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Finding

The RPC response.

Overrides

GetFindingAsync(GetFindingRequest, CallSettings)

public override Task<Finding> GetFindingAsync(GetFindingRequest request, CallSettings callSettings = null)

Gets a Finding.

Parameters
NameDescription
requestGetFindingRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Finding>

A Task containing the RPC response.

Overrides

GetScanConfig(GetScanConfigRequest, CallSettings)

public override ScanConfig GetScanConfig(GetScanConfigRequest request, CallSettings callSettings = null)

Gets a ScanConfig.

Parameters
NameDescription
requestGetScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScanConfig

The RPC response.

Overrides

GetScanConfigAsync(GetScanConfigRequest, CallSettings)

public override Task<ScanConfig> GetScanConfigAsync(GetScanConfigRequest request, CallSettings callSettings = null)

Gets a ScanConfig.

Parameters
NameDescription
requestGetScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScanConfig>

A Task containing the RPC response.

Overrides

GetScanRun(GetScanRunRequest, CallSettings)

public override ScanRun GetScanRun(GetScanRunRequest request, CallSettings callSettings = null)

Gets a ScanRun.

Parameters
NameDescription
requestGetScanRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScanRun

The RPC response.

Overrides

GetScanRunAsync(GetScanRunRequest, CallSettings)

public override Task<ScanRun> GetScanRunAsync(GetScanRunRequest request, CallSettings callSettings = null)

Gets a ScanRun.

Parameters
NameDescription
requestGetScanRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScanRun>

A Task containing the RPC response.

Overrides

ListCrawledUrls(ListCrawledUrlsRequest, CallSettings)

public override PagedEnumerable<ListCrawledUrlsResponse, CrawledUrl> ListCrawledUrls(ListCrawledUrlsRequest request, CallSettings callSettings = null)

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
requestListCrawledUrlsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListCrawledUrlsResponse, CrawledUrl>

A pageable sequence of CrawledUrl resources.

Overrides

ListCrawledUrlsAsync(ListCrawledUrlsRequest, CallSettings)

public override PagedAsyncEnumerable<ListCrawledUrlsResponse, CrawledUrl> ListCrawledUrlsAsync(ListCrawledUrlsRequest request, CallSettings callSettings = null)

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
requestListCrawledUrlsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListCrawledUrlsResponse, CrawledUrl>

A pageable asynchronous sequence of CrawledUrl resources.

Overrides

ListFindings(ListFindingsRequest, CallSettings)

public override PagedEnumerable<ListFindingsResponse, Finding> ListFindings(ListFindingsRequest request, CallSettings callSettings = null)

List Findings under a given ScanRun.

Parameters
NameDescription
requestListFindingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListFindingsResponse, Finding>

A pageable sequence of Finding resources.

Overrides

ListFindingsAsync(ListFindingsRequest, CallSettings)

public override PagedAsyncEnumerable<ListFindingsResponse, Finding> ListFindingsAsync(ListFindingsRequest request, CallSettings callSettings = null)

List Findings under a given ScanRun.

Parameters
NameDescription
requestListFindingsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListFindingsResponse, Finding>

A pageable asynchronous sequence of Finding resources.

Overrides

ListFindingTypeStats(ListFindingTypeStatsRequest, CallSettings)

public override ListFindingTypeStatsResponse ListFindingTypeStats(ListFindingTypeStatsRequest request, CallSettings callSettings = null)

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
requestListFindingTypeStatsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ListFindingTypeStatsResponse

The RPC response.

Overrides

ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, CallSettings)

public override Task<ListFindingTypeStatsResponse> ListFindingTypeStatsAsync(ListFindingTypeStatsRequest request, CallSettings callSettings = null)

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
requestListFindingTypeStatsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ListFindingTypeStatsResponse>

A Task containing the RPC response.

Overrides

ListScanConfigs(ListScanConfigsRequest, CallSettings)

public override PagedEnumerable<ListScanConfigsResponse, ScanConfig> ListScanConfigs(ListScanConfigsRequest request, CallSettings callSettings = null)

Lists ScanConfigs under a given project.

Parameters
NameDescription
requestListScanConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListScanConfigsResponse, ScanConfig>

A pageable sequence of ScanConfig resources.

Overrides

ListScanConfigsAsync(ListScanConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListScanConfigsResponse, ScanConfig> ListScanConfigsAsync(ListScanConfigsRequest request, CallSettings callSettings = null)

Lists ScanConfigs under a given project.

Parameters
NameDescription
requestListScanConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListScanConfigsResponse, ScanConfig>

A pageable asynchronous sequence of ScanConfig resources.

Overrides

ListScanRuns(ListScanRunsRequest, CallSettings)

public override PagedEnumerable<ListScanRunsResponse, ScanRun> ListScanRuns(ListScanRunsRequest request, CallSettings callSettings = null)

Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

Parameters
NameDescription
requestListScanRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListScanRunsResponse, ScanRun>

A pageable sequence of ScanRun resources.

Overrides

ListScanRunsAsync(ListScanRunsRequest, CallSettings)

public override PagedAsyncEnumerable<ListScanRunsResponse, ScanRun> ListScanRunsAsync(ListScanRunsRequest request, CallSettings callSettings = null)

Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

Parameters
NameDescription
requestListScanRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListScanRunsResponse, ScanRun>

A pageable asynchronous sequence of ScanRun resources.

Overrides

StartScanRun(StartScanRunRequest, CallSettings)

public override ScanRun StartScanRun(StartScanRunRequest request, CallSettings callSettings = null)

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
requestStartScanRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScanRun

The RPC response.

Overrides

StartScanRunAsync(StartScanRunRequest, CallSettings)

public override Task<ScanRun> StartScanRunAsync(StartScanRunRequest request, CallSettings callSettings = null)

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
requestStartScanRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScanRun>

A Task containing the RPC response.

Overrides

StopScanRun(StopScanRunRequest, CallSettings)

public override ScanRun StopScanRun(StopScanRunRequest request, CallSettings callSettings = null)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
requestStopScanRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScanRun

The RPC response.

Overrides

StopScanRunAsync(StopScanRunRequest, CallSettings)

public override Task<ScanRun> StopScanRunAsync(StopScanRunRequest request, CallSettings callSettings = null)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
requestStopScanRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScanRun>

A Task containing the RPC response.

Overrides

UpdateScanConfig(UpdateScanConfigRequest, CallSettings)

public override ScanConfig UpdateScanConfig(UpdateScanConfigRequest request, CallSettings callSettings = null)

Updates a ScanConfig. This method support partial update of a ScanConfig.

Parameters
NameDescription
requestUpdateScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScanConfig

The RPC response.

Overrides

UpdateScanConfigAsync(UpdateScanConfigRequest, CallSettings)

public override Task<ScanConfig> UpdateScanConfigAsync(UpdateScanConfigRequest request, CallSettings callSettings = null)

Updates a ScanConfig. This method support partial update of a ScanConfig.

Parameters
NameDescription
requestUpdateScanConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScanConfig>

A Task containing the RPC response.

Overrides