public sealed class DataScanServiceClientImpl : DataScanServiceClientReference documentation and code samples for the Cloud Dataplex v1 API class DataScanServiceClientImpl.
DataScanService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Dataplex.V1Assembly
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 | DataScanServiceDataScanServiceClientThe underlying gRPC client. |
settings | DataScanServiceSettingsThe base DataScanServiceSettings used within this client. |
logger | ILoggerOptional 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 | |
DeleteDataScanOperationsClient
public override OperationsClient DeleteDataScanOperationsClient { get; }The long-running operations client for DeleteDataScan.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override DataScanService.DataScanServiceClient GrpcClient { get; }The underlying gRPC DataScanService client
| Property Value | |
|---|---|
| Type | Description |
DataScanServiceDataScanServiceClient | |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
UpdateDataScanOperationsClient
public override OperationsClient UpdateDataScanOperationsClient { get; }The long-running operations client for UpdateDataScan.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CreateDataScan(CreateDataScanRequest, CallSettings)
public override Operation<DataScan, OperationMetadata> CreateDataScan(CreateDataScanRequest request, CallSettings callSettings = null)Creates a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | CreateDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDataScanOperationMetadata | The RPC response. |
CreateDataScanAsync(CreateDataScanRequest, CallSettings)
public override Task<Operation<DataScan, OperationMetadata>> CreateDataScanAsync(CreateDataScanRequest request, CallSettings callSettings = null)Creates a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | CreateDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDataScanOperationMetadata | A Task containing the RPC response. |
DeleteDataScan(DeleteDataScanRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteDataScan(DeleteDataScanRequest request, CallSettings callSettings = null)Deletes a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteDataScanAsync(DeleteDataScanRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteDataScanAsync(DeleteDataScanRequest request, CallSettings callSettings = null)Deletes a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
GenerateDataQualityRules(GenerateDataQualityRulesRequest, CallSettings)
public override GenerateDataQualityRulesResponse GenerateDataQualityRules(GenerateDataQualityRulesRequest request, CallSettings callSettings = null)Generates recommended DataQualityRule from a data profiling DataScan.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateDataQualityRulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
GenerateDataQualityRulesResponse | The RPC response. |
GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest, CallSettings)
public override Task<GenerateDataQualityRulesResponse> GenerateDataQualityRulesAsync(GenerateDataQualityRulesRequest request, CallSettings callSettings = null)Generates recommended DataQualityRule from a data profiling DataScan.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateDataQualityRulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskGenerateDataQualityRulesResponse | A Task containing the RPC response. |
GetDataScan(GetDataScanRequest, CallSettings)
public override DataScan GetDataScan(GetDataScanRequest request, CallSettings callSettings = null)Gets a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
DataScan | The RPC response. |
GetDataScanAsync(GetDataScanRequest, CallSettings)
public override Task<DataScan> GetDataScanAsync(GetDataScanRequest request, CallSettings callSettings = null)Gets a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDataScan | A Task containing the RPC response. |
GetDataScanJob(GetDataScanJobRequest, CallSettings)
public override DataScanJob GetDataScanJob(GetDataScanJobRequest request, CallSettings callSettings = null)Gets a DataScanJob resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetDataScanJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
DataScanJob | The RPC response. |
GetDataScanJobAsync(GetDataScanJobRequest, CallSettings)
public override Task<DataScanJob> GetDataScanJobAsync(GetDataScanJobRequest request, CallSettings callSettings = null)Gets a DataScanJob resource.
| Parameters | |
|---|---|
| Name | Description |
request | GetDataScanJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDataScanJob | A Task containing the RPC response. |
ListDataScanJobs(ListDataScanJobsRequest, CallSettings)
public override PagedEnumerable<ListDataScanJobsResponse, DataScanJob> ListDataScanJobs(ListDataScanJobsRequest request, CallSettings callSettings = null)Lists DataScanJobs under the given DataScan.
| Parameters | |
|---|---|
| Name | Description |
request | ListDataScanJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDataScanJobsResponseDataScanJob | A pageable sequence of DataScanJob resources. |
ListDataScanJobsAsync(ListDataScanJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListDataScanJobsResponse, DataScanJob> ListDataScanJobsAsync(ListDataScanJobsRequest request, CallSettings callSettings = null)Lists DataScanJobs under the given DataScan.
| Parameters | |
|---|---|
| Name | Description |
request | ListDataScanJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDataScanJobsResponseDataScanJob | A pageable asynchronous sequence of DataScanJob resources. |
ListDataScans(ListDataScansRequest, CallSettings)
public override PagedEnumerable<ListDataScansResponse, DataScan> ListDataScans(ListDataScansRequest request, CallSettings callSettings = null)Lists DataScans.
| Parameters | |
|---|---|
| Name | Description |
request | ListDataScansRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListDataScansResponseDataScan | A pageable sequence of DataScan resources. |
ListDataScansAsync(ListDataScansRequest, CallSettings)
public override PagedAsyncEnumerable<ListDataScansResponse, DataScan> ListDataScansAsync(ListDataScansRequest request, CallSettings callSettings = null)Lists DataScans.
| Parameters | |
|---|---|
| Name | Description |
request | ListDataScansRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListDataScansResponseDataScan | A pageable asynchronous sequence of DataScan resources. |
RunDataScan(RunDataScanRequest, CallSettings)
public override RunDataScanResponse RunDataScan(RunDataScanRequest request, CallSettings callSettings = null)Runs an on-demand execution of a DataScan
| Parameters | |
|---|---|
| Name | Description |
request | RunDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RunDataScanResponse | The RPC response. |
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 | RunDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRunDataScanResponse | A Task containing the RPC response. |
UpdateDataScan(UpdateDataScanRequest, CallSettings)
public override Operation<DataScan, OperationMetadata> UpdateDataScan(UpdateDataScanRequest request, CallSettings callSettings = null)Updates a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDataScanOperationMetadata | The RPC response. |
UpdateDataScanAsync(UpdateDataScanRequest, CallSettings)
public override Task<Operation<DataScan, OperationMetadata>> UpdateDataScanAsync(UpdateDataScanRequest request, CallSettings callSettings = null)Updates a DataScan resource.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDataScanRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDataScanOperationMetadata | A Task containing the RPC response. |