0
# Data Profiling
1

2
Access to data profiles and insights generated by discovery scans, providing visibility into data sensitivity, distribution, and risk levels across projects, tables, columns, and file stores.
3

4
## Capabilities
5

6
### Project Data Profiles
7

8
```python { .api }
9
def list_project_data_profiles(
10
    request: dlp.ListProjectDataProfilesRequest,
11
    *,
12
    parent: Optional[str] = None,
13
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
14
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
15
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
16
) -> pagers.ListProjectDataProfilesPager: ...
17

18
def get_project_data_profile(
19
    request: dlp.GetProjectDataProfileRequest,
20
    *,
21
    name: Optional[str] = None,
22
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
23
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
24
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
25
) -> dlp.ProjectDataProfile: ...
26
```
27

28
### Table Data Profiles
29

30
```python { .api }
31
def list_table_data_profiles(
32
    request: dlp.ListTableDataProfilesRequest,
33
    *,
34
    parent: Optional[str] = None,
35
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
36
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
37
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
38
) -> pagers.ListTableDataProfilesPager: ...
39

40
def get_table_data_profile(
41
    request: dlp.GetTableDataProfileRequest,
42
    *,
43
    name: Optional[str] = None,
44
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
45
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
46
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
47
) -> dlp.TableDataProfile: ...
48

49
def delete_table_data_profile(
50
    request: dlp.DeleteTableDataProfileRequest,
51
    *,
52
    name: Optional[str] = None,
53
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
54
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
55
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
56
) -> None: ...
57
```
58

59
### Column Data Profiles
60

61
```python { .api }
62
def list_column_data_profiles(
63
    request: dlp.ListColumnDataProfilesRequest,
64
    *,
65
    parent: Optional[str] = None,
66
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
67
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
68
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
69
) -> pagers.ListColumnDataProfilesPager: ...
70

71
def get_column_data_profile(
72
    request: dlp.GetColumnDataProfileRequest,
73
    *,
74
    name: Optional[str] = None,
75
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
76
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
77
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
78
) -> dlp.ColumnDataProfile: ...
79
```
80

81
### File Store Data Profiles
82

83
```python { .api }
84
def list_file_store_data_profiles(
85
    request: dlp.ListFileStoreDataProfilesRequest,
86
    *,
87
    parent: Optional[str] = None,
88
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
89
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
90
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
91
) -> pagers.ListFileStoreDataProfilesPager: ...
92

93
def get_file_store_data_profile(
94
    request: dlp.GetFileStoreDataProfileRequest,
95
    *,
96
    name: Optional[str] = None,
97
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
98
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
99
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
100
) -> dlp.FileStoreDataProfile: ...
101

102
def delete_file_store_data_profile(
103
    request: dlp.DeleteFileStoreDataProfileRequest,
104
    *,
105
    name: Optional[str] = None,
106
    retry: OptionalRetry = gapic_v1.method.DEFAULT,
107
    timeout: Union[float, object] = gapic_v1.method.DEFAULT,
108
    metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
109
) -> None: ...
110
```
111

112
## Types
113

114
```python { .api }
115
class ProjectDataProfile:
116
    """Data profile for a Google Cloud project."""
117
    
118
    name: str
119
    project_id: str
120
    location: str
121
    profile_status: ProfileStatus
122
    state: DataProfileJobState
123
    profile_last_generated: timestamp_pb2.Timestamp
124
    table_count: int
125
    sensitive_data_size_bytes: int
126

127
class TableDataProfile:
128
    """Data profile for a BigQuery table."""
129
    
130
    name: str
131
    data_source_type: DataSourceType
132
    project_data_profile: str
133
    dataset_project_id: str
134
    dataset_location: str
135
    dataset_id: str
136
    table_id: str
137
    full_resource: str
138
    profile_status: ProfileStatus
139
    state: DataProfileJobState
140
    profile_last_generated: timestamp_pb2.Timestamp
141
    row_count: int
142
    estimated_bytes: int
143
    column_count: int
144
    predicted_info_types: Sequence[InfoTypeSummary]
145
    other_info_types: Sequence[OtherInfoTypeSummary]
146

147
class ColumnDataProfile:
148
    """Data profile for a BigQuery table column."""
149
    
150
    name: str
151
    profile_status: ProfileStatus
152
    state: DataProfileJobState
153
    profile_last_generated: timestamp_pb2.Timestamp
154
    table_data_profile: str
155
    table_full_resource: str
156
    dataset_project_id: str
157
    dataset_location: str
158
    dataset_id: str
159
    table_id: str
160
    column: str
161
    sensitivity_score: SensitivityScore
162
    data_risk_level: DataRiskLevel
163
    column_info_type: InfoTypeSummary
164
    other_matches: Sequence[OtherInfoTypeSummary]
165
    estimated_null_percentage: NullPercentageLevel
166
    estimated_uniqueness_score: UniquenessScoreLevel
167
    free_text_score: float
168
    column_type: ColumnDataProfile.ColumnDataType
169
    policy_state: ColumnDataProfile.ColumnPolicyState
170

171
class FileStoreDataProfile:
172
    """Data profile for a file store."""
173
    
174
    name: str
175
    data_source_type: DataSourceType
176
    project_data_profile: str
177
    location: str
178
    file_store_path: str
179
    data_storage_locations: Sequence[str]
180
    location_type: FileStoreDataProfile.LocationType
181
    file_cluster_summaries: Sequence[FileClusterSummary]
182
    config_snapshot: DataProfileConfigSnapshot
183
    profile_status: ProfileStatus
184
    state: DataProfileJobState
185
    profile_last_generated: timestamp_pb2.Timestamp
186
    resource_visibility: ResourceVisibility
187
    sensitivity_score: SensitivityScore
188
    data_risk_level: DataRiskLevel
189
    file_store_info_type_summaries: Sequence[FileStoreInfoTypeSummary]
190
    file_store_is_empty: bool
191
```