Cloud Dataplex v1 API - Class DataScanServiceClientImpl (2.4.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

Inherited Members

DataScanServiceClient.DefaultEndpoint

DataScanServiceClient.DefaultScopes

DataScanServiceClient.ServiceMetadata

DataScanServiceClient.CreateAsync(CancellationToken)

DataScanServiceClient.Create()

DataScanServiceClient.ShutdownDefaultChannelsAsync()

DataScanServiceClient.CreateDataScanAsync(CreateDataScanRequest, CancellationToken)

DataScanServiceClient.PollOnceCreateDataScan(string, CallSettings)

DataScanServiceClient.PollOnceCreateDataScanAsync(string, CallSettings)

DataScanServiceClient.CreateDataScan(string, DataScan, string, CallSettings)

DataScanServiceClient.CreateDataScanAsync(string, DataScan, string, CallSettings)

DataScanServiceClient.CreateDataScanAsync(string, DataScan, string, CancellationToken)

DataScanServiceClient.CreateDataScan(LocationName, DataScan, string, CallSettings)

DataScanServiceClient.CreateDataScanAsync(LocationName, DataScan, string, CallSettings)

DataScanServiceClient.CreateDataScanAsync(LocationName, DataScan, string, CancellationToken)

DataScanServiceClient.UpdateDataScanAsync(UpdateDataScanRequest, CancellationToken)

DataScanServiceClient.PollOnceUpdateDataScan(string, CallSettings)

DataScanServiceClient.PollOnceUpdateDataScanAsync(string, CallSettings)

DataScanServiceClient.UpdateDataScan(DataScan, FieldMask, CallSettings)

DataScanServiceClient.UpdateDataScanAsync(DataScan, FieldMask, CallSettings)

DataScanServiceClient.UpdateDataScanAsync(DataScan, FieldMask, CancellationToken)

DataScanServiceClient.DeleteDataScanAsync(DeleteDataScanRequest, CancellationToken)

DataScanServiceClient.PollOnceDeleteDataScan(string, CallSettings)

DataScanServiceClient.PollOnceDeleteDataScanAsync(string, CallSettings)

DataScanServiceClient.DeleteDataScan(string, CallSettings)

DataScanServiceClient.DeleteDataScanAsync(string, CallSettings)

DataScanServiceClient.DeleteDataScanAsync(string, CancellationToken)

DataScanServiceClient.DeleteDataScan(DataScanName, CallSettings)

DataScanServiceClient.DeleteDataScanAsync(DataScanName, CallSettings)

DataScanServiceClient.DeleteDataScanAsync(DataScanName, CancellationToken)

DataScanServiceClient.GetDataScanAsync(GetDataScanRequest, CancellationToken)

DataScanServiceClient.GetDataScan(string, CallSettings)

DataScanServiceClient.GetDataScanAsync(string, CallSettings)

DataScanServiceClient.GetDataScanAsync(string, CancellationToken)

DataScanServiceClient.GetDataScan(DataScanName, CallSettings)

DataScanServiceClient.GetDataScanAsync(DataScanName, CallSettings)

DataScanServiceClient.GetDataScanAsync(DataScanName, CancellationToken)

DataScanServiceClient.ListDataScans(string, string, int?, CallSettings)

DataScanServiceClient.ListDataScansAsync(string, string, int?, CallSettings)

DataScanServiceClient.ListDataScans(LocationName, string, int?, CallSettings)

DataScanServiceClient.ListDataScansAsync(LocationName, string, int?, CallSettings)

DataScanServiceClient.RunDataScanAsync(RunDataScanRequest, CancellationToken)

DataScanServiceClient.RunDataScan(string, CallSettings)

DataScanServiceClient.RunDataScanAsync(string, CallSettings)

DataScanServiceClient.RunDataScanAsync(string, CancellationToken)

DataScanServiceClient.RunDataScan(DataScanName, CallSettings)

DataScanServiceClient.RunDataScanAsync(DataScanName, CallSettings)

DataScanServiceClient.RunDataScanAsync(DataScanName, CancellationToken)

DataScanServiceClient.GetDataScanJobAsync(GetDataScanJobRequest, CancellationToken)

DataScanServiceClient.GetDataScanJob(string, CallSettings)

DataScanServiceClient.GetDataScanJobAsync(string, CallSettings)

DataScanServiceClient.GetDataScanJobAsync(string, CancellationToken)

DataScanServiceClient.GetDataScanJob(DataScanJobName, CallSettings)

DataScanServiceClient.GetDataScanJobAsync(DataScanJobName, CallSettings)

DataScanServiceClient.GetDataScanJobAsync(DataScanJobName, CancellationToken)

DataScanServiceClient.ListDataScanJobs(string, string, int?, CallSettings)

DataScanServiceClient.ListDataScanJobsAsync(string, string, int?, CallSettings)

DataScanServiceClient.ListDataScanJobs(DataScanName, string, int?, CallSettings)

DataScanServiceClient.ListDataScanJobsAsync(DataScanName, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

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

DataScanServiceClient.CreateDataScanOperationsClient

DeleteDataScanOperationsClient

public override OperationsClient DeleteDataScanOperationsClient { get; }

The long-running operations client for DeleteDataScan.

Property Value
Type	Description
`OperationsClient`

Overrides

DataScanServiceClient.DeleteDataScanOperationsClient

GrpcClient

public override DataScanService.DataScanServiceClient GrpcClient { get; }

The underlying gRPC DataScanService client

Property Value
Type	Description
`DataScanServiceDataScanServiceClient`

Overrides

DataScanServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
`IAMPolicyClient`

Overrides

DataScanServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

DataScanServiceClient.LocationsClient

UpdateDataScanOperationsClient

public override OperationsClient UpdateDataScanOperationsClient { get; }

The long-running operations client for UpdateDataScan.

Property Value
Type	Description
`OperationsClient`

Overrides

DataScanServiceClient.UpdateDataScanOperationsClient

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

DataScanServiceClient.CreateDataScan(CreateDataScanRequest, CallSettings)

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

DataScanServiceClient.CreateDataScanAsync(CreateDataScanRequest, CallSettings)

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

DataScanServiceClient.DeleteDataScan(DeleteDataScanRequest, CallSettings)

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

DataScanServiceClient.DeleteDataScanAsync(DeleteDataScanRequest, CallSettings)

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

DataScanServiceClient.GetDataScan(GetDataScanRequest, CallSettings)

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

DataScanServiceClient.GetDataScanAsync(GetDataScanRequest, CallSettings)

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

DataScanServiceClient.GetDataScanJob(GetDataScanJobRequest, CallSettings)

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

DataScanServiceClient.GetDataScanJobAsync(GetDataScanJobRequest, CallSettings)

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

DataScanServiceClient.ListDataScanJobs(ListDataScanJobsRequest, CallSettings)

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

DataScanServiceClient.ListDataScanJobsAsync(ListDataScanJobsRequest, CallSettings)

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

DataScanServiceClient.ListDataScans(ListDataScansRequest, CallSettings)

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

DataScanServiceClient.ListDataScansAsync(ListDataScansRequest, CallSettings)

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

DataScanServiceClient.RunDataScan(RunDataScanRequest, CallSettings)

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

DataScanServiceClient.RunDataScanAsync(RunDataScanRequest, CallSettings)

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

DataScanServiceClient.UpdateDataScan(UpdateDataScanRequest, CallSettings)

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

DataScanServiceClient.UpdateDataScanAsync(UpdateDataScanRequest, CallSettings)