Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Class WebSecurityScannerClient (1.0.0)

public abstract class WebSecurityScannerClient

WebSecurityScanner client wrapper, for convenient use.

Inheritance

System.Object > WebSecurityScannerClient

Inherited Members

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Derived Types

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.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the WebSecurityScanner service, which is a host of "websecurityscanner.googleapis.com" and a port of 443.

Property Value
Type	Description
`System.String`

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default WebSecurityScanner scopes.

Property Value
Type	Description
`System.Collections.Generic.IReadOnlyList<System.String>`

Remarks

The default WebSecurityScanner scopes are:

https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual WebSecurityScanner.WebSecurityScannerClient GrpcClient { get; }

The underlying gRPC WebSecurityScanner client

Property Value
Type	Description
`WebSecurityScanner.WebSecurityScannerClient`

Methods

Create()

public static WebSecurityScannerClient Create()

Synchronously creates a WebSecurityScannerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use WebSecurityScannerClientBuilder .

Returns
Type	Description
`WebSecurityScannerClient`	The created WebSecurityScannerClient.

CreateAsync(CancellationToken)

public static Task<WebSecurityScannerClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a WebSecurityScannerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use WebSecurityScannerClientBuilder .

Parameter
Name	Description
`cancellationToken`	`System.Threading.CancellationToken` The System.Threading.CancellationToken to use while creating the client.

Returns
Type	Description
`System.Threading.Tasks.Task<WebSecurityScannerClient>`	The task representing the created WebSecurityScannerClient.

CreateScanConfig(CreateScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ScanConfig`	The RPC response.

CreateScanConfigAsync(CreateScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanConfig>`	A Task containing the RPC response.

CreateScanConfigAsync(CreateScanConfigRequest, CancellationToken)

public virtual Task<ScanConfig> CreateScanConfigAsync(CreateScanConfigRequest request, CancellationToken cancellationToken)

Creates a new ScanConfig.

Parameters
Name	Description
`request`	`CreateScanConfigRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanConfig>`	A Task containing the RPC response.

DeleteScanConfig(DeleteScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

DeleteScanConfigAsync(DeleteScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task`	A Task containing the RPC response.

DeleteScanConfigAsync(DeleteScanConfigRequest, CancellationToken)

public virtual Task DeleteScanConfigAsync(DeleteScanConfigRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task`	A Task containing the RPC response.

GetFinding(GetFindingRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Finding`	The RPC response.

GetFindingAsync(GetFindingRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<Finding>`	A Task containing the RPC response.

GetFindingAsync(GetFindingRequest, CancellationToken)

public virtual Task<Finding> GetFindingAsync(GetFindingRequest request, CancellationToken cancellationToken)

Gets a Finding.

Parameters
Name	Description
`request`	`GetFindingRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<Finding>`	A Task containing the RPC response.

GetScanConfig(GetScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ScanConfig`	The RPC response.

GetScanConfigAsync(GetScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanConfig>`	A Task containing the RPC response.

GetScanConfigAsync(GetScanConfigRequest, CancellationToken)

public virtual Task<ScanConfig> GetScanConfigAsync(GetScanConfigRequest request, CancellationToken cancellationToken)

Gets a ScanConfig.

Parameters
Name	Description
`request`	`GetScanConfigRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanConfig>`	A Task containing the RPC response.

GetScanRun(GetScanRunRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ScanRun`	The RPC response.

GetScanRunAsync(GetScanRunRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanRun>`	A Task containing the RPC response.

GetScanRunAsync(GetScanRunRequest, CancellationToken)

public virtual Task<ScanRun> GetScanRunAsync(GetScanRunRequest request, CancellationToken cancellationToken)

Gets a ScanRun.

Parameters
Name	Description
`request`	`GetScanRunRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanRun>`	A Task containing the RPC response.

ListCrawledUrls(ListCrawledUrlsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedEnumerable<ListCrawledUrlsResponse, CrawledUrl>`	A pageable sequence of CrawledUrl resources.

ListCrawledUrlsAsync(ListCrawledUrlsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedAsyncEnumerable<ListCrawledUrlsResponse, CrawledUrl>`	A pageable asynchronous sequence of CrawledUrl resources.

ListFindings(ListFindingsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedEnumerable<ListFindingsResponse, Finding>`	A pageable sequence of Finding resources.

ListFindingsAsync(ListFindingsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedAsyncEnumerable<ListFindingsResponse, Finding>`	A pageable asynchronous sequence of Finding resources.

ListFindingTypeStats(ListFindingTypeStatsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ListFindingTypeStatsResponse`	The RPC response.

ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<ListFindingTypeStatsResponse>`	A Task containing the RPC response.

ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, CancellationToken)

public virtual Task<ListFindingTypeStatsResponse> ListFindingTypeStatsAsync(ListFindingTypeStatsRequest request, CancellationToken cancellationToken)

List all FindingTypeStats under a given ScanRun.

Parameters
Name	Description
`request`	`ListFindingTypeStatsRequest` The request object containing all of the parameters for the API call.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<ListFindingTypeStatsResponse>`	A Task containing the RPC response.

ListScanConfigs(ListScanConfigsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedEnumerable<ListScanConfigsResponse, ScanConfig>`	A pageable sequence of ScanConfig resources.

ListScanConfigsAsync(ListScanConfigsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedAsyncEnumerable<ListScanConfigsResponse, ScanConfig>`	A pageable asynchronous sequence of ScanConfig resources.

ListScanRuns(ListScanRunsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedEnumerable<ListScanRunsResponse, ScanRun>`	A pageable sequence of ScanRun resources.

ListScanRunsAsync(ListScanRunsRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Google.Api.Gax.PagedAsyncEnumerable<ListScanRunsResponse, ScanRun>`	A pageable asynchronous sequence of ScanRun resources.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
`System.Threading.Tasks.Task`	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

StartScanRun(StartScanRunRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ScanRun`	The RPC response.

StartScanRunAsync(StartScanRunRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanRun>`	A Task containing the RPC response.

StartScanRunAsync(StartScanRunRequest, CancellationToken)

public virtual Task<ScanRun> StartScanRunAsync(StartScanRunRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanRun>`	A Task containing the RPC response.

StopScanRun(StopScanRunRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ScanRun`	The RPC response.

StopScanRunAsync(StopScanRunRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanRun>`	A Task containing the RPC response.

StopScanRunAsync(StopScanRunRequest, CancellationToken)

public virtual Task<ScanRun> StopScanRunAsync(StopScanRunRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanRun>`	A Task containing the RPC response.

UpdateScanConfig(UpdateScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ScanConfig`	The RPC response.

UpdateScanConfigAsync(UpdateScanConfigRequest, CallSettings)

public virtual 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`	`Google.Api.Gax.Grpc.CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanConfig>`	A Task containing the RPC response.

UpdateScanConfigAsync(UpdateScanConfigRequest, CancellationToken)

public virtual Task<ScanConfig> UpdateScanConfigAsync(UpdateScanConfigRequest request, CancellationToken cancellationToken)

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.
`cancellationToken`	`System.Threading.CancellationToken` A System.Threading.CancellationToken to use for this RPC.

Returns
Type	Description
`System.Threading.Tasks.Task<ScanConfig>`	A Task containing the RPC response.