Class DataScanServiceClient (2.29.0)

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.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

DataScanServiceClient(DataScanServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataScanServiceClient const &`

DataScanServiceClient(DataScanServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataScanServiceClient &&`

DataScanServiceClient(std::shared_ptr< DataScanServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< DataScanServiceConnection >`
`opts`	`Options`

Operators

operator=(DataScanServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataScanServiceClient const &`

Returns
Type	Description
`DataScanServiceClient &`

operator=(DataScanServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataScanServiceClient &&`

Returns
Type	Description
`DataScanServiceClient &`

Functions

CreateDataScan(std::string const &, google::cloud::dataplex::v1::DataScan const &, std::string const &, Options)

Creates a DataScan resource.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent location: `projects/{project}/locations/{location_id}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region.
`data_scan`	`google::cloud::dataplex::v1::DataScan const &` Required. DataScan resource.
`data_scan_id`	`std::string const &` Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::DataScan > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataplex.v1.DataScan proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateDataScan(NoAwaitTag, std::string const &, google::cloud::dataplex::v1::DataScan const &, std::string const &, Options)

Creates a DataScan resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`parent`	`std::string const &`
`data_scan`	`google::cloud::dataplex::v1::DataScan const &`
`data_scan_id`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateDataScan(google::cloud::dataplex::v1::CreateDataScanRequest const &, Options)

Creates a DataScan resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::CreateDataScanRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.CreateDataScanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::DataScan > >

CreateDataScan(NoAwaitTag, google::cloud::dataplex::v1::CreateDataScanRequest const &, Options)

Creates a DataScan resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::CreateDataScanRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateDataScan(google::longrunning::Operation const &, Options)

Creates a DataScan resource.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::DataScan > >`

UpdateDataScan(google::cloud::dataplex::v1::DataScan const &, google::protobuf::FieldMask const &, Options)

Updates a DataScan resource.

Parameters
Name	Description
`data_scan`	`google::cloud::dataplex::v1::DataScan const &` Required. DataScan resource to be updated. Only fields specified in `update_mask` are updated.
`update_mask`	`google::protobuf::FieldMask const &` Required. Mask of fields to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::DataScan > >

UpdateDataScan(NoAwaitTag, google::cloud::dataplex::v1::DataScan const &, google::protobuf::FieldMask const &, Options)

Updates a DataScan resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`data_scan`	`google::cloud::dataplex::v1::DataScan const &`
`update_mask`	`google::protobuf::FieldMask const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateDataScan(google::cloud::dataplex::v1::UpdateDataScanRequest const &, Options)

Updates a DataScan resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::UpdateDataScanRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.UpdateDataScanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::DataScan > >

UpdateDataScan(NoAwaitTag, google::cloud::dataplex::v1::UpdateDataScanRequest const &, Options)

Updates a DataScan resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::UpdateDataScanRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

UpdateDataScan(google::longrunning::Operation const &, Options)

Updates a DataScan resource.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::DataScan > >`

DeleteDataScan(std::string const &, Options)

Deletes a DataScan resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the dataScan: `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDataScan(NoAwaitTag, std::string const &, Options)

Deletes a DataScan resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`name`	`std::string const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteDataScan(google::cloud::dataplex::v1::DeleteDataScanRequest const &, Options)

Deletes a DataScan resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::DeleteDataScanRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.DeleteDataScanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.dataplex.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteDataScan(NoAwaitTag, google::cloud::dataplex::v1::DeleteDataScanRequest const &, Options)

Deletes a DataScan resource.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`NoAwaitTag`
`request`	`google::cloud::dataplex::v1::DeleteDataScanRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

DeleteDataScan(google::longrunning::Operation const &, Options)

Deletes a DataScan resource.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::dataplex::v1::OperationMetadata > >`

GetDataScan(std::string const &, Options)

Gets a DataScan resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the dataScan: `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::DataScan >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDataScan(google::cloud::dataplex::v1::GetDataScanRequest const &, Options)

Gets a DataScan resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::GetDataScanRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.GetDataScanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::DataScan >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScan) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDataScans(std::string const &, Options)

Lists DataScans.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent location: `projects/{project}/locations/{location_id}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::DataScan >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataplex.v1.DataScan, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDataScans(google::cloud::dataplex::v1::ListDataScansRequest, Options)

Lists DataScans.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::ListDataScansRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.ListDataScansRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::DataScan >

RunDataScan(std::string const &, Options)

Runs an on-demand execution of a DataScan.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the DataScan: `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}`. where `project` refers to a project_id or project_number and `location_id` refers to a GCP region. Only OnDemand data scans are allowed.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::RunDataScanResponse >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.RunDataScanResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RunDataScan(google::cloud::dataplex::v1::RunDataScanRequest const &, Options)

Runs an on-demand execution of a DataScan.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::RunDataScanRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.RunDataScanRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::RunDataScanResponse >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.RunDataScanResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDataScanJob(std::string const &, Options)

Gets a DataScanJob resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the DataScanJob: `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}/jobs/{data_scan_job_id}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::DataScanJob >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScanJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetDataScanJob(google::cloud::dataplex::v1::GetDataScanJobRequest const &, Options)

Gets a DataScanJob resource.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::GetDataScanJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.GetDataScanJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::DataScanJob >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.DataScanJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListDataScanJobs(std::string const &, Options)

Lists DataScanJobs under the given DataScan.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the parent environment: `projects/{project}/locations/{location_id}/dataScans/{data_scan_id}` where `project` refers to a project_id or project_number and `location_id` refers to a GCP region.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::DataScanJob >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataplex.v1.DataScanJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDataScanJobs(google::cloud::dataplex::v1::ListDataScanJobsRequest, Options)

Lists DataScanJobs under the given DataScan.

Parameters
Name	Description
`request`	`google::cloud::dataplex::v1::ListDataScanJobsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.ListDataScanJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::dataplex::v1::DataScanJob >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dataplex.v1.DataScanJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GenerateDataQualityRules(std::string const &, 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

name

std::string const &

Required. The name must be one of the following:

The name of a data scan with at least one successful, completed data profiling job
The name of a successful, completed data profiling job (a data scan job where the job type is data profiling)

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::GenerateDataQualityRulesResponse >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.GenerateDataQualityRulesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GenerateDataQualityRules(google::cloud::dataplex::v1::GenerateDataQualityRulesRequest const &, 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`	`google::cloud::dataplex::v1::GenerateDataQualityRulesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dataplex.v1.GenerateDataQualityRulesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::dataplex::v1::GenerateDataQualityRulesResponse >`	the result of the RPC. The response message type (google.cloud.dataplex.v1.GenerateDataQualityRulesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.