Web Security Scanner v1 API - Class WebSecurityScanner.WebSecurityScannerClient (2.3.0)

public class WebSecurityScanner.WebSecurityScannerClient : ClientBase<WebSecurityScanner.WebSecurityScannerClient>

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

Client for WebSecurityScanner

Inheritance

object > ClientBase > ClientBaseWebSecurityScannerWebSecurityScannerClient > WebSecurityScanner.WebSecurityScannerClient

Namespace

Google.Cloud.WebSecurityScanner.V1

Assembly

Google.Cloud.WebSecurityScanner.V1.dll

Constructors

WebSecurityScannerClient()

protected WebSecurityScannerClient()

Protected parameterless constructor to allow creation of test doubles.

WebSecurityScannerClient(CallInvoker)

public WebSecurityScannerClient(CallInvoker callInvoker)

Creates a new client for WebSecurityScanner that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

WebSecurityScannerClient(ChannelBase)

public WebSecurityScannerClient(ChannelBase channel)

Creates a new client for WebSecurityScanner

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

WebSecurityScannerClient(ClientBaseConfiguration)

protected WebSecurityScannerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateScanConfig(CreateScanConfigRequest, CallOptions)

public virtual ScanConfig CreateScanConfig(CreateScanConfigRequest request, CallOptions options)

Creates a new ScanConfig.

Parameters
NameDescription
requestCreateScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ScanConfig

The response received from the server.

CreateScanConfig(CreateScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual ScanConfig CreateScanConfig(CreateScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new ScanConfig.

Parameters
NameDescription
requestCreateScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ScanConfig

The response received from the server.

CreateScanConfigAsync(CreateScanConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ScanConfig> CreateScanConfigAsync(CreateScanConfigRequest request, CallOptions options)

Creates a new ScanConfig.

Parameters
NameDescription
requestCreateScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallScanConfig

The call object.

CreateScanConfigAsync(CreateScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ScanConfig> CreateScanConfigAsync(CreateScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new ScanConfig.

Parameters
NameDescription
requestCreateScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallScanConfig

The call object.

DeleteScanConfig(DeleteScanConfigRequest, CallOptions)

public virtual Empty DeleteScanConfig(DeleteScanConfigRequest request, CallOptions options)

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
requestDeleteScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteScanConfig(DeleteScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteScanConfig(DeleteScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
requestDeleteScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteScanConfigAsync(DeleteScanConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteScanConfigAsync(DeleteScanConfigRequest request, CallOptions options)

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
requestDeleteScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteScanConfigAsync(DeleteScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteScanConfigAsync(DeleteScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
requestDeleteScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

GetFinding(GetFindingRequest, CallOptions)

public virtual Finding GetFinding(GetFindingRequest request, CallOptions options)

Gets a Finding.

Parameters
NameDescription
requestGetFindingRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Finding

The response received from the server.

GetFinding(GetFindingRequest, Metadata, DateTime?, CancellationToken)

public virtual Finding GetFinding(GetFindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Finding.

Parameters
NameDescription
requestGetFindingRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Finding

The response received from the server.

GetFindingAsync(GetFindingRequest, CallOptions)

public virtual AsyncUnaryCall<Finding> GetFindingAsync(GetFindingRequest request, CallOptions options)

Gets a Finding.

Parameters
NameDescription
requestGetFindingRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallFinding

The call object.

GetFindingAsync(GetFindingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Finding> GetFindingAsync(GetFindingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Finding.

Parameters
NameDescription
requestGetFindingRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallFinding

The call object.

GetScanConfig(GetScanConfigRequest, CallOptions)

public virtual ScanConfig GetScanConfig(GetScanConfigRequest request, CallOptions options)

Gets a ScanConfig.

Parameters
NameDescription
requestGetScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ScanConfig

The response received from the server.

GetScanConfig(GetScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual ScanConfig GetScanConfig(GetScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ScanConfig.

Parameters
NameDescription
requestGetScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ScanConfig

The response received from the server.

GetScanConfigAsync(GetScanConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ScanConfig> GetScanConfigAsync(GetScanConfigRequest request, CallOptions options)

Gets a ScanConfig.

Parameters
NameDescription
requestGetScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallScanConfig

The call object.

GetScanConfigAsync(GetScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ScanConfig> GetScanConfigAsync(GetScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ScanConfig.

Parameters
NameDescription
requestGetScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallScanConfig

The call object.

GetScanRun(GetScanRunRequest, CallOptions)

public virtual ScanRun GetScanRun(GetScanRunRequest request, CallOptions options)

Gets a ScanRun.

Parameters
NameDescription
requestGetScanRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ScanRun

The response received from the server.

GetScanRun(GetScanRunRequest, Metadata, DateTime?, CancellationToken)

public virtual ScanRun GetScanRun(GetScanRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ScanRun.

Parameters
NameDescription
requestGetScanRunRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ScanRun

The response received from the server.

GetScanRunAsync(GetScanRunRequest, CallOptions)

public virtual AsyncUnaryCall<ScanRun> GetScanRunAsync(GetScanRunRequest request, CallOptions options)

Gets a ScanRun.

Parameters
NameDescription
requestGetScanRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallScanRun

The call object.

GetScanRunAsync(GetScanRunRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ScanRun> GetScanRunAsync(GetScanRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a ScanRun.

Parameters
NameDescription
requestGetScanRunRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallScanRun

The call object.

ListCrawledUrls(ListCrawledUrlsRequest, CallOptions)

public virtual ListCrawledUrlsResponse ListCrawledUrls(ListCrawledUrlsRequest request, CallOptions options)

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
requestListCrawledUrlsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListCrawledUrlsResponse

The response received from the server.

ListCrawledUrls(ListCrawledUrlsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCrawledUrlsResponse ListCrawledUrls(ListCrawledUrlsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
requestListCrawledUrlsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListCrawledUrlsResponse

The response received from the server.

ListCrawledUrlsAsync(ListCrawledUrlsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCrawledUrlsResponse> ListCrawledUrlsAsync(ListCrawledUrlsRequest request, CallOptions options)

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
requestListCrawledUrlsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListCrawledUrlsResponse

The call object.

ListCrawledUrlsAsync(ListCrawledUrlsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCrawledUrlsResponse> ListCrawledUrlsAsync(ListCrawledUrlsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
requestListCrawledUrlsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListCrawledUrlsResponse

The call object.

ListFindingTypeStats(ListFindingTypeStatsRequest, CallOptions)

public virtual ListFindingTypeStatsResponse ListFindingTypeStats(ListFindingTypeStatsRequest request, CallOptions options)

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
requestListFindingTypeStatsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListFindingTypeStatsResponse

The response received from the server.

ListFindingTypeStats(ListFindingTypeStatsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFindingTypeStatsResponse ListFindingTypeStats(ListFindingTypeStatsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
requestListFindingTypeStatsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListFindingTypeStatsResponse

The response received from the server.

ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, CallOptions)

public virtual AsyncUnaryCall<ListFindingTypeStatsResponse> ListFindingTypeStatsAsync(ListFindingTypeStatsRequest request, CallOptions options)

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
requestListFindingTypeStatsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListFindingTypeStatsResponse

The call object.

ListFindingTypeStatsAsync(ListFindingTypeStatsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFindingTypeStatsResponse> ListFindingTypeStatsAsync(ListFindingTypeStatsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
requestListFindingTypeStatsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListFindingTypeStatsResponse

The call object.

ListFindings(ListFindingsRequest, CallOptions)

public virtual ListFindingsResponse ListFindings(ListFindingsRequest request, CallOptions options)

List Findings under a given ScanRun.

Parameters
NameDescription
requestListFindingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListFindingsResponse

The response received from the server.

ListFindings(ListFindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFindingsResponse ListFindings(ListFindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List Findings under a given ScanRun.

Parameters
NameDescription
requestListFindingsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListFindingsResponse

The response received from the server.

ListFindingsAsync(ListFindingsRequest, CallOptions)

public virtual AsyncUnaryCall<ListFindingsResponse> ListFindingsAsync(ListFindingsRequest request, CallOptions options)

List Findings under a given ScanRun.

Parameters
NameDescription
requestListFindingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListFindingsResponse

The call object.

ListFindingsAsync(ListFindingsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFindingsResponse> ListFindingsAsync(ListFindingsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List Findings under a given ScanRun.

Parameters
NameDescription
requestListFindingsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListFindingsResponse

The call object.

ListScanConfigs(ListScanConfigsRequest, CallOptions)

public virtual ListScanConfigsResponse ListScanConfigs(ListScanConfigsRequest request, CallOptions options)

Lists ScanConfigs under a given project.

Parameters
NameDescription
requestListScanConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListScanConfigsResponse

The response received from the server.

ListScanConfigs(ListScanConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListScanConfigsResponse ListScanConfigs(ListScanConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ScanConfigs under a given project.

Parameters
NameDescription
requestListScanConfigsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListScanConfigsResponse

The response received from the server.

ListScanConfigsAsync(ListScanConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListScanConfigsResponse> ListScanConfigsAsync(ListScanConfigsRequest request, CallOptions options)

Lists ScanConfigs under a given project.

Parameters
NameDescription
requestListScanConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListScanConfigsResponse

The call object.

ListScanConfigsAsync(ListScanConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListScanConfigsResponse> ListScanConfigsAsync(ListScanConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ScanConfigs under a given project.

Parameters
NameDescription
requestListScanConfigsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListScanConfigsResponse

The call object.

ListScanRuns(ListScanRunsRequest, CallOptions)

public virtual ListScanRunsResponse ListScanRuns(ListScanRunsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListScanRunsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListScanRunsResponse

The response received from the server.

ListScanRuns(ListScanRunsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListScanRunsResponse ListScanRuns(ListScanRunsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListScanRunsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListScanRunsResponse

The response received from the server.

ListScanRunsAsync(ListScanRunsRequest, CallOptions)

public virtual AsyncUnaryCall<ListScanRunsResponse> ListScanRunsAsync(ListScanRunsRequest request, CallOptions options)

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

Parameters
NameDescription
requestListScanRunsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListScanRunsResponse

The call object.

ListScanRunsAsync(ListScanRunsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListScanRunsResponse> ListScanRunsAsync(ListScanRunsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListScanRunsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListScanRunsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override WebSecurityScanner.WebSecurityScannerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
WebSecurityScannerWebSecurityScannerClient
Overrides

StartScanRun(StartScanRunRequest, CallOptions)

public virtual ScanRun StartScanRun(StartScanRunRequest request, CallOptions options)

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
requestStartScanRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ScanRun

The response received from the server.

StartScanRun(StartScanRunRequest, Metadata, DateTime?, CancellationToken)

public virtual ScanRun StartScanRun(StartScanRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
requestStartScanRunRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ScanRun

The response received from the server.

StartScanRunAsync(StartScanRunRequest, CallOptions)

public virtual AsyncUnaryCall<ScanRun> StartScanRunAsync(StartScanRunRequest request, CallOptions options)

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
requestStartScanRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallScanRun

The call object.

StartScanRunAsync(StartScanRunRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ScanRun> StartScanRunAsync(StartScanRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
requestStartScanRunRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallScanRun

The call object.

StopScanRun(StopScanRunRequest, CallOptions)

public virtual ScanRun StopScanRun(StopScanRunRequest request, CallOptions options)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
requestStopScanRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ScanRun

The response received from the server.

StopScanRun(StopScanRunRequest, Metadata, DateTime?, CancellationToken)

public virtual ScanRun StopScanRun(StopScanRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
requestStopScanRunRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ScanRun

The response received from the server.

StopScanRunAsync(StopScanRunRequest, CallOptions)

public virtual AsyncUnaryCall<ScanRun> StopScanRunAsync(StopScanRunRequest request, CallOptions options)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
requestStopScanRunRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallScanRun

The call object.

StopScanRunAsync(StopScanRunRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ScanRun> StopScanRunAsync(StopScanRunRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
requestStopScanRunRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallScanRun

The call object.

UpdateScanConfig(UpdateScanConfigRequest, CallOptions)

public virtual ScanConfig UpdateScanConfig(UpdateScanConfigRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ScanConfig

The response received from the server.

UpdateScanConfig(UpdateScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual ScanConfig UpdateScanConfig(UpdateScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestUpdateScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ScanConfig

The response received from the server.

UpdateScanConfigAsync(UpdateScanConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ScanConfig> UpdateScanConfigAsync(UpdateScanConfigRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateScanConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallScanConfig

The call object.

UpdateScanConfigAsync(UpdateScanConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ScanConfig> UpdateScanConfigAsync(UpdateScanConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestUpdateScanConfigRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallScanConfig

The call object.