pub struct DataScanService { /* private fields */ }Expand description
Implements a client for the Cloud Dataplex API.
§Example
let client = DataScanService::builder().build().await?;
// use `client` to make requests to the Cloud Dataplex API.§Service Description
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.
§Configuration
To configure DataScanService use the with_* methods in the type returned
by builder(). The default configuration should
work for most applications. Common configuration changes include
- with_endpoint(): by default this client uses the global default endpoint
(
https://dataplex.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default. - with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.
§Pooling and Cloning
DataScanService holds a connection pool internally, it is advised to
create one and the reuse it. You do not need to wrap DataScanService in
an Rc or Arc to reuse it, because it
already uses an Arc internally.
Implementations§
Source§impl DataScanService
impl DataScanService
Sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Returns a builder for DataScanService.
let client = DataScanService::builder().build().await?;Sourcepub fn from_stub<T>(stub: T) -> Selfwhere
T: DataScanService + 'static,
pub fn from_stub<T>(stub: T) -> Selfwhere
T: DataScanService + 'static,
Creates a new client from the provided stub.
The most common case for calling this function is in tests mocking the client’s behavior.
Sourcepub fn create_data_scan(&self) -> CreateDataScan
pub fn create_data_scan(&self) -> CreateDataScan
Creates a DataScan resource.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn update_data_scan(&self) -> UpdateDataScan
pub fn update_data_scan(&self) -> UpdateDataScan
Updates a DataScan resource.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn delete_data_scan(&self) -> DeleteDataScan
pub fn delete_data_scan(&self) -> DeleteDataScan
Deletes a DataScan resource.
§Long running operations
This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.
Sourcepub fn get_data_scan(&self) -> GetDataScan
pub fn get_data_scan(&self) -> GetDataScan
Gets a DataScan resource.
Sourcepub fn list_data_scans(&self) -> ListDataScans
pub fn list_data_scans(&self) -> ListDataScans
Lists DataScans.
Sourcepub fn run_data_scan(&self) -> RunDataScan
pub fn run_data_scan(&self) -> RunDataScan
Runs an on-demand execution of a DataScan
Sourcepub fn get_data_scan_job(&self) -> GetDataScanJob
pub fn get_data_scan_job(&self) -> GetDataScanJob
Gets a DataScanJob resource.
Sourcepub fn list_data_scan_jobs(&self) -> ListDataScanJobs
pub fn list_data_scan_jobs(&self) -> ListDataScanJobs
Lists DataScanJobs under the given DataScan.
Sourcepub fn generate_data_quality_rules(&self) -> GenerateDataQualityRules
pub fn generate_data_quality_rules(&self) -> GenerateDataQualityRules
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.
Sourcepub fn list_locations(&self) -> ListLocations
pub fn list_locations(&self) -> ListLocations
Lists information about the supported locations for this service.
Sourcepub fn get_location(&self) -> GetLocation
pub fn get_location(&self) -> GetLocation
Gets information about a location.
Sourcepub fn set_iam_policy(&self) -> SetIamPolicy
pub fn set_iam_policy(&self) -> SetIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
errors.
Sourcepub fn get_iam_policy(&self) -> GetIamPolicy
pub fn get_iam_policy(&self) -> GetIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Sourcepub fn test_iam_permissions(&self) -> TestIamPermissions
pub fn test_iam_permissions(&self) -> TestIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Sourcepub fn list_operations(&self) -> ListOperations
pub fn list_operations(&self) -> ListOperations
Provides the Operations service functionality in this service.
Sourcepub fn get_operation(&self) -> GetOperation
pub fn get_operation(&self) -> GetOperation
Provides the Operations service functionality in this service.
Sourcepub fn delete_operation(&self) -> DeleteOperation
pub fn delete_operation(&self) -> DeleteOperation
Provides the Operations service functionality in this service.
Sourcepub fn cancel_operation(&self) -> CancelOperation
pub fn cancel_operation(&self) -> CancelOperation
Provides the Operations service functionality in this service.
Trait Implementations§
Source§impl Clone for DataScanService
impl Clone for DataScanService
Source§fn clone(&self) -> DataScanService
fn clone(&self) -> DataScanService
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more