Cloud Dataplex v1 API - Class DataScanService.DataScanServiceClient (3.2.0)

public class DataScanService.DataScanServiceClient : ClientBase<DataScanService.DataScanServiceClient>

Reference documentation and code samples for the Cloud Dataplex v1 API class DataScanService.DataScanServiceClient.

Client for DataScanService

Inheritance

object > ClientBase > ClientBase DataScanService DataScanServiceClient > DataScanService.DataScanServiceClient

Inherited Members

ClientBase<DataScanService.DataScanServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataScanServiceClient()

protected DataScanServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataScanServiceClient(CallInvoker)

public DataScanServiceClient(CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

DataScanServiceClient(ChannelBase)

public DataScanServiceClient(ChannelBase channel)

Creates a new client for DataScanService

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

DataScanServiceClient(ClientBaseConfiguration)

protected DataScanServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateDataScan(CreateDataScanRequest, CallOptions)

public virtual Operation CreateDataScan(CreateDataScanRequest request, CallOptions options)

Creates a DataScan resource.

Parameters
Name	Description
`request`	`CreateDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateDataScan(CreateDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateDataScan(CreateDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a DataScan resource.

Parameters
Name	Description
`request`	`CreateDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateDataScanAsync(CreateDataScanRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDataScanAsync(CreateDataScanRequest request, CallOptions options)

Creates a DataScan resource.

Parameters
Name	Description
`request`	`CreateDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateDataScanAsync(CreateDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateDataScanAsync(CreateDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a DataScan resource.

Parameters
Name	Description
`request`	`CreateDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
`IAMPolicyIAMPolicyClient`	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
`LocationsLocationsClient`	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`OperationsOperationsClient`	A new Operations client for the same target as this client.

DeleteDataScan(DeleteDataScanRequest, CallOptions)

public virtual Operation DeleteDataScan(DeleteDataScanRequest request, CallOptions options)

Deletes a DataScan resource.

Parameters
Name	Description
`request`	`DeleteDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteDataScan(DeleteDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteDataScan(DeleteDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a DataScan resource.

Parameters
Name	Description
`request`	`DeleteDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteDataScanAsync(DeleteDataScanRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDataScanAsync(DeleteDataScanRequest request, CallOptions options)

Deletes a DataScan resource.

Parameters
Name	Description
`request`	`DeleteDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteDataScanAsync(DeleteDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteDataScanAsync(DeleteDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a DataScan resource.

Parameters
Name	Description
`request`	`DeleteDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

GenerateDataQualityRules(GenerateDataQualityRulesRequest, CallOptions)

public virtual GenerateDataQualityRulesResponse GenerateDataQualityRules(GenerateDataQualityRulesRequest request, CallOptions options)

Generates recommended data quality rules based on the results of a data profiling scan.

Use the recommendations to build rules for a data quality scan.

Parameters
Name	Description
`request`	`GenerateDataQualityRulesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`GenerateDataQualityRulesResponse`	The response received from the server.

GenerateDataQualityRules(GenerateDataQualityRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateDataQualityRulesResponse GenerateDataQualityRules(GenerateDataQualityRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates recommended data quality rules based on the results of a data profiling scan.

Use the recommendations to build rules for a data quality scan.

Parameters
Name	Description
`request`	`GenerateDataQualityRulesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`GenerateDataQualityRulesResponse`	The response received from the server.

GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateDataQualityRulesResponse> GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest request, CallOptions options)

Generates recommended data quality rules based on the results of a data profiling scan.

Use the recommendations to build rules for a data quality scan.

Parameters
Name	Description
`request`	`GenerateDataQualityRulesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallGenerateDataQualityRulesResponse`	The call object.

GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateDataQualityRulesResponse> GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates recommended data quality rules based on the results of a data profiling scan.

Use the recommendations to build rules for a data quality scan.

Parameters
Name	Description
`request`	`GenerateDataQualityRulesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallGenerateDataQualityRulesResponse`	The call object.

GetDataScan(GetDataScanRequest, CallOptions)

public virtual DataScan GetDataScan(GetDataScanRequest request, CallOptions options)

Gets a DataScan resource.

Parameters
Name	Description
`request`	`GetDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`DataScan`	The response received from the server.

GetDataScan(GetDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual DataScan GetDataScan(GetDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a DataScan resource.

Parameters
Name	Description
`request`	`GetDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`DataScan`	The response received from the server.

GetDataScanAsync(GetDataScanRequest, CallOptions)

public virtual AsyncUnaryCall<DataScan> GetDataScanAsync(GetDataScanRequest request, CallOptions options)

Gets a DataScan resource.

Parameters
Name	Description
`request`	`GetDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallDataScan`	The call object.

GetDataScanAsync(GetDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataScan> GetDataScanAsync(GetDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a DataScan resource.

Parameters
Name	Description
`request`	`GetDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallDataScan`	The call object.

GetDataScanJob(GetDataScanJobRequest, CallOptions)

public virtual DataScanJob GetDataScanJob(GetDataScanJobRequest request, CallOptions options)

Gets a DataScanJob resource.

Parameters
Name	Description
`request`	`GetDataScanJobRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`DataScanJob`	The response received from the server.

GetDataScanJob(GetDataScanJobRequest, Metadata, DateTime?, CancellationToken)

public virtual DataScanJob GetDataScanJob(GetDataScanJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a DataScanJob resource.

Parameters
Name	Description
`request`	`GetDataScanJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`DataScanJob`	The response received from the server.

GetDataScanJobAsync(GetDataScanJobRequest, CallOptions)

public virtual AsyncUnaryCall<DataScanJob> GetDataScanJobAsync(GetDataScanJobRequest request, CallOptions options)

Gets a DataScanJob resource.

Parameters
Name	Description
`request`	`GetDataScanJobRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallDataScanJob`	The call object.

GetDataScanJobAsync(GetDataScanJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataScanJob> GetDataScanJobAsync(GetDataScanJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a DataScanJob resource.

Parameters
Name	Description
`request`	`GetDataScanJobRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallDataScanJob`	The call object.

ListDataScanJobs(ListDataScanJobsRequest, CallOptions)

public virtual ListDataScanJobsResponse ListDataScanJobs(ListDataScanJobsRequest request, CallOptions options)

Lists DataScanJobs under the given DataScan.

Parameters
Name	Description
`request`	`ListDataScanJobsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListDataScanJobsResponse`	The response received from the server.

ListDataScanJobs(ListDataScanJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataScanJobsResponse ListDataScanJobs(ListDataScanJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataScanJobs under the given DataScan.

Parameters
Name	Description
`request`	`ListDataScanJobsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListDataScanJobsResponse`	The response received from the server.

ListDataScanJobsAsync(ListDataScanJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataScanJobsResponse> ListDataScanJobsAsync(ListDataScanJobsRequest request, CallOptions options)

Lists DataScanJobs under the given DataScan.

Parameters
Name	Description
`request`	`ListDataScanJobsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListDataScanJobsResponse`	The call object.

ListDataScanJobsAsync(ListDataScanJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataScanJobsResponse> ListDataScanJobsAsync(ListDataScanJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataScanJobs under the given DataScan.

Parameters
Name	Description
`request`	`ListDataScanJobsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListDataScanJobsResponse`	The call object.

ListDataScans(ListDataScansRequest, CallOptions)

public virtual ListDataScansResponse ListDataScans(ListDataScansRequest request, CallOptions options)

Lists DataScans.

Parameters
Name	Description
`request`	`ListDataScansRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListDataScansResponse`	The response received from the server.

ListDataScans(ListDataScansRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataScansResponse ListDataScans(ListDataScansRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataScans.

Parameters
Name	Description
`request`	`ListDataScansRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListDataScansResponse`	The response received from the server.

ListDataScansAsync(ListDataScansRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataScansResponse> ListDataScansAsync(ListDataScansRequest request, CallOptions options)

Lists DataScans.

Parameters
Name	Description
`request`	`ListDataScansRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListDataScansResponse`	The call object.

ListDataScansAsync(ListDataScansRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataScansResponse> ListDataScansAsync(ListDataScansRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists DataScans.

Parameters
Name	Description
`request`	`ListDataScansRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListDataScansResponse`	The call object.

NewInstance(ClientBaseConfiguration)

protected override DataScanService.DataScanServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`DataScanServiceDataScanServiceClient`

Overrides

ClientBase<DataScanService.DataScanServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

RunDataScan(RunDataScanRequest, CallOptions)

public virtual RunDataScanResponse RunDataScan(RunDataScanRequest request, CallOptions options)

Runs an on-demand execution of a DataScan

Parameters
Name	Description
`request`	`RunDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`RunDataScanResponse`	The response received from the server.

RunDataScan(RunDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual RunDataScanResponse RunDataScan(RunDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Runs an on-demand execution of a DataScan

Parameters
Name	Description
`request`	`RunDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`RunDataScanResponse`	The response received from the server.

RunDataScanAsync(RunDataScanRequest, CallOptions)

public virtual AsyncUnaryCall<RunDataScanResponse> RunDataScanAsync(RunDataScanRequest request, CallOptions options)

Runs an on-demand execution of a DataScan

Parameters
Name	Description
`request`	`RunDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallRunDataScanResponse`	The call object.

RunDataScanAsync(RunDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RunDataScanResponse> RunDataScanAsync(RunDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Runs an on-demand execution of a DataScan

Parameters
Name	Description
`request`	`RunDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallRunDataScanResponse`	The call object.

UpdateDataScan(UpdateDataScanRequest, CallOptions)

public virtual Operation UpdateDataScan(UpdateDataScanRequest request, CallOptions options)

Updates a DataScan resource.

Parameters
Name	Description
`request`	`UpdateDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateDataScan(UpdateDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateDataScan(UpdateDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a DataScan resource.

Parameters
Name	Description
`request`	`UpdateDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateDataScanAsync(UpdateDataScanRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDataScanAsync(UpdateDataScanRequest request, CallOptions options)

Updates a DataScan resource.

Parameters
Name	Description
`request`	`UpdateDataScanRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

UpdateDataScanAsync(UpdateDataScanRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateDataScanAsync(UpdateDataScanRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a DataScan resource.

Parameters
Name	Description
`request`	`UpdateDataScanRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.