Skip to main content

data_scans

Overview

Namedata_scans
TypeResource
Idgoogle.dataplex.data_scans

Fields

NameDatatypeDescription
namestringOutput only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region.
descriptionstringOptional. Description of the scan. Must be between 1-1024 characters.
createTimestringOutput only. The time when the scan was created.
dataobjectThe data source for DataScan.
dataProfileResultobjectDataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result.
dataProfileSpecobjectDataProfileScan related setting.
dataQualityResultobjectThe output of a DataQualityScan.
dataQualitySpecobjectDataQualityScan related setting.
displayNamestringOptional. User friendly display name. Must be between 1-256 characters.
executionSpecobjectDataScan execution settings.
executionStatusobjectStatus of the data scan execution.
labelsobjectOptional. User-defined labels for the scan.
statestringOutput only. Current state of the DataScan.
typestringOutput only. The type of DataScan.
uidstringOutput only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name.
updateTimestringOutput only. The time when the scan was last updated.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_data_scans_getSELECTdataScansId, locationsId, projectsIdGets a DataScan resource.
projects_locations_data_scans_listSELECTlocationsId, projectsIdLists DataScans.
projects_locations_data_scans_createINSERTlocationsId, projectsIdCreates a DataScan resource.
projects_locations_data_scans_deleteDELETEdataScansId, locationsId, projectsIdDeletes a DataScan resource.
_projects_locations_data_scans_listEXEClocationsId, projectsIdLists DataScans.
projects_locations_data_scans_patchEXECdataScansId, locationsId, projectsIdUpdates a DataScan resource.
projects_locations_data_scans_runEXECdataScansId, locationsId, projectsIdRuns an on-demand execution of a DataScan