Web Security Scanner v1 API - Class WebSecurityScannerClientImpl (2.3.0)

Version 2.3.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.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

Inherited Members

WebSecurityScannerClient.DefaultEndpoint

WebSecurityScannerClient.DefaultScopes

WebSecurityScannerClient.ServiceMetadata

WebSecurityScannerClient.CreateAsync(CancellationToken)

WebSecurityScannerClient.Create()

WebSecurityScannerClient.ShutdownDefaultChannelsAsync()

WebSecurityScannerClient.CreateScanConfigAsync(CreateScanConfigRequest, CancellationToken)

WebSecurityScannerClient.DeleteScanConfigAsync(DeleteScanConfigRequest, CancellationToken)

WebSecurityScannerClient.GetScanConfigAsync(GetScanConfigRequest, CancellationToken)

WebSecurityScannerClient.UpdateScanConfigAsync(UpdateScanConfigRequest, CancellationToken)

WebSecurityScannerClient.StartScanRunAsync(StartScanRunRequest, CancellationToken)

WebSecurityScannerClient.GetScanRunAsync(GetScanRunRequest, CancellationToken)

WebSecurityScannerClient.StopScanRunAsync(StopScanRunRequest, CancellationToken)

WebSecurityScannerClient.GetFindingAsync(GetFindingRequest, CancellationToken)

WebSecurityScannerClient.ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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(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
Name	Description
grpcClient	WebSecurityScannerWebSecurityScannerClient The underlying gRPC client.
settings	WebSecurityScannerSettings The base WebSecurityScannerSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override WebSecurityScanner.WebSecurityScannerClient GrpcClient { get; }

The underlying gRPC WebSecurityScanner client

Property Value
Type	Description
WebSecurityScannerWebSecurityScannerClient

Overrides

WebSecurityScannerClient.GrpcClient

Methods

CreateScanConfig(CreateScanConfigRequest, CallSettings)

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

Creates a new ScanConfig.

Parameters
Name	Description
request	CreateScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ScanConfig	The RPC response.

Overrides

WebSecurityScannerClient.CreateScanConfig(CreateScanConfigRequest, CallSettings)

CreateScanConfigAsync(CreateScanConfigRequest, CallSettings)

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

Creates a new ScanConfig.

Parameters
Name	Description
request	CreateScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskScanConfig	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.CreateScanConfigAsync(CreateScanConfigRequest, CallSettings)

DeleteScanConfig(DeleteScanConfigRequest, CallSettings)

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

Deletes an existing ScanConfig and its child resources.

Parameters
Name	Description
request	DeleteScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

WebSecurityScannerClient.DeleteScanConfig(DeleteScanConfigRequest, CallSettings)

DeleteScanConfigAsync(DeleteScanConfigRequest, CallSettings)

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

Deletes an existing ScanConfig and its child resources.

Parameters
Name	Description
request	DeleteScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.DeleteScanConfigAsync(DeleteScanConfigRequest, CallSettings)

GetFinding(GetFindingRequest, CallSettings)

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

Gets a Finding.

Parameters
Name	Description
request	GetFindingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Finding	The RPC response.

Overrides

WebSecurityScannerClient.GetFinding(GetFindingRequest, CallSettings)

GetFindingAsync(GetFindingRequest, CallSettings)

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

Gets a Finding.

Parameters
Name	Description
request	GetFindingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskFinding	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.GetFindingAsync(GetFindingRequest, CallSettings)

GetScanConfig(GetScanConfigRequest, CallSettings)

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

Gets a ScanConfig.

Parameters
Name	Description
request	GetScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ScanConfig	The RPC response.

Overrides

WebSecurityScannerClient.GetScanConfig(GetScanConfigRequest, CallSettings)

GetScanConfigAsync(GetScanConfigRequest, CallSettings)

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

Gets a ScanConfig.

Parameters
Name	Description
request	GetScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskScanConfig	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.GetScanConfigAsync(GetScanConfigRequest, CallSettings)

GetScanRun(GetScanRunRequest, CallSettings)

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

Gets a ScanRun.

Parameters
Name	Description
request	GetScanRunRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ScanRun	The RPC response.

Overrides

WebSecurityScannerClient.GetScanRun(GetScanRunRequest, CallSettings)

GetScanRunAsync(GetScanRunRequest, CallSettings)

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

Gets a ScanRun.

Parameters
Name	Description
request	GetScanRunRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskScanRun	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.GetScanRunAsync(GetScanRunRequest, CallSettings)

ListCrawledUrls(ListCrawledUrlsRequest, CallSettings)

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

List CrawledUrls under a given ScanRun.

Parameters
Name	Description
request	ListCrawledUrlsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListCrawledUrlsResponseCrawledUrl	A pageable sequence of CrawledUrl resources.

Overrides

WebSecurityScannerClient.ListCrawledUrls(ListCrawledUrlsRequest, CallSettings)

ListCrawledUrlsAsync(ListCrawledUrlsRequest, CallSettings)

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

List CrawledUrls under a given ScanRun.

Parameters
Name	Description
request	ListCrawledUrlsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListCrawledUrlsResponseCrawledUrl	A pageable asynchronous sequence of CrawledUrl resources.

Overrides

WebSecurityScannerClient.ListCrawledUrlsAsync(ListCrawledUrlsRequest, CallSettings)

ListFindingTypeStats(ListFindingTypeStatsRequest, CallSettings)

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

List all FindingTypeStats under a given ScanRun.

Parameters
Name	Description
request	ListFindingTypeStatsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ListFindingTypeStatsResponse	The RPC response.

Overrides

WebSecurityScannerClient.ListFindingTypeStats(ListFindingTypeStatsRequest, CallSettings)

ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, CallSettings)

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

List all FindingTypeStats under a given ScanRun.

Parameters
Name	Description
request	ListFindingTypeStatsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskListFindingTypeStatsResponse	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, CallSettings)

ListFindings(ListFindingsRequest, CallSettings)

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

List Findings under a given ScanRun.

Parameters
Name	Description
request	ListFindingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListFindingsResponseFinding	A pageable sequence of Finding resources.

Overrides

WebSecurityScannerClient.ListFindings(ListFindingsRequest, CallSettings)

ListFindingsAsync(ListFindingsRequest, CallSettings)

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

List Findings under a given ScanRun.

Parameters
Name	Description
request	ListFindingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListFindingsResponseFinding	A pageable asynchronous sequence of Finding resources.

Overrides

WebSecurityScannerClient.ListFindingsAsync(ListFindingsRequest, CallSettings)

ListScanConfigs(ListScanConfigsRequest, CallSettings)

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

Lists ScanConfigs under a given project.

Parameters
Name	Description
request	ListScanConfigsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListScanConfigsResponseScanConfig	A pageable sequence of ScanConfig resources.

Overrides

WebSecurityScannerClient.ListScanConfigs(ListScanConfigsRequest, CallSettings)

ListScanConfigsAsync(ListScanConfigsRequest, CallSettings)

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

Lists ScanConfigs under a given project.

Parameters
Name	Description
request	ListScanConfigsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListScanConfigsResponseScanConfig	A pageable asynchronous sequence of ScanConfig resources.

Overrides

WebSecurityScannerClient.ListScanConfigsAsync(ListScanConfigsRequest, CallSettings)

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
Name	Description
request	ListScanRunsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListScanRunsResponseScanRun	A pageable sequence of ScanRun resources.

Overrides

WebSecurityScannerClient.ListScanRuns(ListScanRunsRequest, CallSettings)

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
Name	Description
request	ListScanRunsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListScanRunsResponseScanRun	A pageable asynchronous sequence of ScanRun resources.

Overrides

WebSecurityScannerClient.ListScanRunsAsync(ListScanRunsRequest, CallSettings)

StartScanRun(StartScanRunRequest, CallSettings)

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

Start a ScanRun according to the given ScanConfig.

Parameters
Name	Description
request	StartScanRunRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ScanRun	The RPC response.

Overrides

WebSecurityScannerClient.StartScanRun(StartScanRunRequest, CallSettings)

StartScanRunAsync(StartScanRunRequest, CallSettings)

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

Start a ScanRun according to the given ScanConfig.

Parameters
Name	Description
request	StartScanRunRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskScanRun	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.StartScanRunAsync(StartScanRunRequest, CallSettings)

StopScanRun(StopScanRunRequest, CallSettings)

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

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
Name	Description
request	StopScanRunRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ScanRun	The RPC response.

Overrides

WebSecurityScannerClient.StopScanRun(StopScanRunRequest, CallSettings)

StopScanRunAsync(StopScanRunRequest, CallSettings)

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

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
Name	Description
request	StopScanRunRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskScanRun	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.StopScanRunAsync(StopScanRunRequest, CallSettings)

UpdateScanConfig(UpdateScanConfigRequest, CallSettings)

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

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

Parameters
Name	Description
request	UpdateScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ScanConfig	The RPC response.

Overrides

WebSecurityScannerClient.UpdateScanConfig(UpdateScanConfigRequest, CallSettings)

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
Name	Description
request	UpdateScanConfigRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskScanConfig	A Task containing the RPC response.

Overrides

WebSecurityScannerClient.UpdateScanConfigAsync(UpdateScanConfigRequest, CallSettings)