Web Security Scanner v1 API - Class WebSecurityScanner.WebSecurityScannerBase (2.5.0)

Version latest

• 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

[BindServiceMethod(typeof(WebSecurityScanner), "BindService")]
public abstract class WebSecurityScanner.WebSecurityScannerBase

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

Base class for server-side implementations of WebSecurityScanner

Inheritance

object > WebSecurityScanner.WebSecurityScannerBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.WebSecurityScanner.V1

Assembly

Google.Cloud.WebSecurityScanner.V1.dll

Methods

CreateScanConfig(CreateScanConfigRequest, ServerCallContext)

public virtual Task<ScanConfig> CreateScanConfig(CreateScanConfigRequest request, ServerCallContext context)

Creates a new ScanConfig.

Parameters
Name	Description
request	CreateScanConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScanConfig	The response to send back to the client (wrapped by a task).

DeleteScanConfig(DeleteScanConfigRequest, ServerCallContext)

public virtual Task<Empty> DeleteScanConfig(DeleteScanConfigRequest request, ServerCallContext context)

Deletes an existing ScanConfig and its child resources.

Parameters
Name	Description
request	DeleteScanConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GetFinding(GetFindingRequest, ServerCallContext)

public virtual Task<Finding> GetFinding(GetFindingRequest request, ServerCallContext context)

Gets a Finding.

Parameters
Name	Description
request	GetFindingRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFinding	The response to send back to the client (wrapped by a task).

GetScanConfig(GetScanConfigRequest, ServerCallContext)

public virtual Task<ScanConfig> GetScanConfig(GetScanConfigRequest request, ServerCallContext context)

Gets a ScanConfig.

Parameters
Name	Description
request	GetScanConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScanConfig	The response to send back to the client (wrapped by a task).

GetScanRun(GetScanRunRequest, ServerCallContext)

public virtual Task<ScanRun> GetScanRun(GetScanRunRequest request, ServerCallContext context)

Gets a ScanRun.

Parameters
Name	Description
request	GetScanRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScanRun	The response to send back to the client (wrapped by a task).

ListCrawledUrls(ListCrawledUrlsRequest, ServerCallContext)

public virtual Task<ListCrawledUrlsResponse> ListCrawledUrls(ListCrawledUrlsRequest request, ServerCallContext context)

List CrawledUrls under a given ScanRun.

Parameters
Name	Description
request	ListCrawledUrlsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListCrawledUrlsResponse	The response to send back to the client (wrapped by a task).

ListFindingTypeStats(ListFindingTypeStatsRequest, ServerCallContext)

public virtual Task<ListFindingTypeStatsResponse> ListFindingTypeStats(ListFindingTypeStatsRequest request, ServerCallContext context)

List all FindingTypeStats under a given ScanRun.

Parameters
Name	Description
request	ListFindingTypeStatsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListFindingTypeStatsResponse	The response to send back to the client (wrapped by a task).

ListFindings(ListFindingsRequest, ServerCallContext)

public virtual Task<ListFindingsResponse> ListFindings(ListFindingsRequest request, ServerCallContext context)

List Findings under a given ScanRun.

Parameters
Name	Description
request	ListFindingsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListFindingsResponse	The response to send back to the client (wrapped by a task).

ListScanConfigs(ListScanConfigsRequest, ServerCallContext)

public virtual Task<ListScanConfigsResponse> ListScanConfigs(ListScanConfigsRequest request, ServerCallContext context)

Lists ScanConfigs under a given project.

Parameters
Name	Description
request	ListScanConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListScanConfigsResponse	The response to send back to the client (wrapped by a task).

ListScanRuns(ListScanRunsRequest, ServerCallContext)

public virtual Task<ListScanRunsResponse> ListScanRuns(ListScanRunsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListScanRunsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListScanRunsResponse	The response to send back to the client (wrapped by a task).

StartScanRun(StartScanRunRequest, ServerCallContext)

public virtual Task<ScanRun> StartScanRun(StartScanRunRequest request, ServerCallContext context)

Start a ScanRun according to the given ScanConfig.

Parameters
Name	Description
request	StartScanRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScanRun	The response to send back to the client (wrapped by a task).

StopScanRun(StopScanRunRequest, ServerCallContext)

public virtual Task<ScanRun> StopScanRun(StopScanRunRequest request, ServerCallContext context)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
Name	Description
request	StopScanRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScanRun	The response to send back to the client (wrapped by a task).

UpdateScanConfig(UpdateScanConfigRequest, ServerCallContext)

public virtual Task<ScanConfig> UpdateScanConfig(UpdateScanConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateScanConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScanConfig	The response to send back to the client (wrapped by a task).