Cloud Dataplex v1 API - Class DataScanServiceClientImpl (3.3.0) 

public sealed class DataScanServiceClientImpl : DataScanServiceClient

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

DataScanService client wrapper implementation, for convenient use.

Inheritance

object > DataScanServiceClient > DataScanServiceClientImpl

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Remarks

DataScanService manages DataScan resources which can be configured to run various types of data scanning workload and generate enriched metadata (e.g. Data Profile, Data Quality) for the data source.

Constructors

DataScanServiceClientImpl(DataScanServiceClient, DataScanServiceSettings, ILogger)

public DataScanServiceClientImpl(DataScanService.DataScanServiceClient grpcClient, DataScanServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DataScanService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient DataScanServiceDataScanServiceClient

The underlying gRPC client.
settings DataScanServiceSettings

The base DataScanServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateDataScanOperationsClient

public override OperationsClient CreateDataScanOperationsClient { get; }

The long-running operations client for CreateDataScan.

Property Value
Type Description
OperationsClient
Overrides

DeleteDataScanOperationsClient

public override OperationsClient DeleteDataScanOperationsClient { get; }

The long-running operations client for DeleteDataScan.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override DataScanService.DataScanServiceClient GrpcClient { get; }

The underlying gRPC DataScanService client

Property Value
Type Description
DataScanServiceDataScanServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateDataScanOperationsClient

public override OperationsClient UpdateDataScanOperationsClient { get; }

The long-running operations client for UpdateDataScan.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateDataScan(CreateDataScanRequest, CallSettings)

public override Operation<DataScan, OperationMetadata> CreateDataScan(CreateDataScanRequest request, CallSettings callSettings = null)

Creates a DataScan resource.

Parameters
Name Description
request CreateDataScanRequest

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
OperationDataScanOperationMetadata

The RPC response.
Overrides

CreateDataScanAsync(CreateDataScanRequest, CallSettings)

public override Task<Operation<DataScan, OperationMetadata>> CreateDataScanAsync(CreateDataScanRequest request, CallSettings callSettings = null)

Creates a DataScan resource.

Parameters
Name Description
request CreateDataScanRequest

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
TaskOperationDataScanOperationMetadata

A Task containing the RPC response.
Overrides

DeleteDataScan(DeleteDataScanRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteDataScan(DeleteDataScanRequest request, CallSettings callSettings = null)

Deletes a DataScan resource.

Parameters
Name Description
request DeleteDataScanRequest

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
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteDataScanAsync(DeleteDataScanRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteDataScanAsync(DeleteDataScanRequest request, CallSettings callSettings = null)

Deletes a DataScan resource.

Parameters
Name Description
request DeleteDataScanRequest

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
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GenerateDataQualityRules(GenerateDataQualityRulesRequest, CallSettings)

public override GenerateDataQualityRulesResponse GenerateDataQualityRules(GenerateDataQualityRulesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateDataQualityRulesResponse

The RPC response.
Overrides

GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest, CallSettings)

public override Task<GenerateDataQualityRulesResponse> GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateDataQualityRulesResponse

A Task containing the RPC response.
Overrides

GetDataScan(GetDataScanRequest, CallSettings)

public override DataScan GetDataScan(GetDataScanRequest request, CallSettings callSettings = null)

Gets a DataScan resource.

Parameters
Name Description
request GetDataScanRequest

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
DataScan

The RPC response.
Overrides

GetDataScanAsync(GetDataScanRequest, CallSettings)

public override Task<DataScan> GetDataScanAsync(GetDataScanRequest request, CallSettings callSettings = null)

Gets a DataScan resource.

Parameters
Name Description
request GetDataScanRequest

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
TaskDataScan

A Task containing the RPC response.
Overrides

GetDataScanJob(GetDataScanJobRequest, CallSettings)

public override DataScanJob GetDataScanJob(GetDataScanJobRequest request, CallSettings callSettings = null)

Gets a DataScanJob resource.

Parameters
Name Description
request GetDataScanJobRequest

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
DataScanJob

The RPC response.
Overrides

GetDataScanJobAsync(GetDataScanJobRequest, CallSettings)

public override Task<DataScanJob> GetDataScanJobAsync(GetDataScanJobRequest request, CallSettings callSettings = null)

Gets a DataScanJob resource.

Parameters
Name Description
request GetDataScanJobRequest

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
TaskDataScanJob

A Task containing the RPC response.
Overrides

ListDataScanJobs(ListDataScanJobsRequest, CallSettings)

public override PagedEnumerable<ListDataScanJobsResponse, DataScanJob> ListDataScanJobs(ListDataScanJobsRequest request, CallSettings callSettings = null)

Lists DataScanJobs under the given DataScan.

Parameters
Name Description
request ListDataScanJobsRequest

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
PagedEnumerableListDataScanJobsResponseDataScanJob

A pageable sequence of DataScanJob resources.
Overrides

ListDataScanJobsAsync(ListDataScanJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataScanJobsResponse, DataScanJob> ListDataScanJobsAsync(ListDataScanJobsRequest request, CallSettings callSettings = null)

Lists DataScanJobs under the given DataScan.

Parameters
Name Description
request ListDataScanJobsRequest

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
PagedAsyncEnumerableListDataScanJobsResponseDataScanJob

A pageable asynchronous sequence of DataScanJob resources.
Overrides

ListDataScans(ListDataScansRequest, CallSettings)

public override PagedEnumerable<ListDataScansResponse, DataScan> ListDataScans(ListDataScansRequest request, CallSettings callSettings = null)

Lists DataScans.

Parameters
Name Description
request ListDataScansRequest

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
PagedEnumerableListDataScansResponseDataScan

A pageable sequence of DataScan resources.
Overrides

ListDataScansAsync(ListDataScansRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataScansResponse, DataScan> ListDataScansAsync(ListDataScansRequest request, CallSettings callSettings = null)

Lists DataScans.

Parameters
Name Description
request ListDataScansRequest

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
PagedAsyncEnumerableListDataScansResponseDataScan

A pageable asynchronous sequence of DataScan resources.
Overrides

RunDataScan(RunDataScanRequest, CallSettings)

public override RunDataScanResponse RunDataScan(RunDataScanRequest request, CallSettings callSettings = null)

Runs an on-demand execution of a DataScan

Parameters
Name Description
request RunDataScanRequest

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
RunDataScanResponse

The RPC response.
Overrides

RunDataScanAsync(RunDataScanRequest, CallSettings)

public override Task<RunDataScanResponse> RunDataScanAsync(RunDataScanRequest request, CallSettings callSettings = null)

Runs an on-demand execution of a DataScan

Parameters
Name Description
request RunDataScanRequest

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
TaskRunDataScanResponse

A Task containing the RPC response.
Overrides

UpdateDataScan(UpdateDataScanRequest, CallSettings)

public override Operation<DataScan, OperationMetadata> UpdateDataScan(UpdateDataScanRequest request, CallSettings callSettings = null)

Updates a DataScan resource.

Parameters
Name Description
request UpdateDataScanRequest

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
OperationDataScanOperationMetadata

The RPC response.
Overrides

UpdateDataScanAsync(UpdateDataScanRequest, CallSettings)

public override Task<Operation<DataScan, OperationMetadata>> UpdateDataScanAsync(UpdateDataScanRequest request, CallSettings callSettings = null)

Updates a DataScan resource.

Parameters
Name Description
request UpdateDataScanRequest

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
TaskOperationDataScanOperationMetadata

A Task containing the RPC response.
Overrides