Debian Codegraph @

docs/dyn/dlp_v2.projects.locations.columnDataProfiles.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dlp_v2.html">Sensitive Data Protection (DLP)</a> . <a href="dlp_v2.projects.html">projects</a> . <a href="dlp_v2.projects.locations.html">locations</a> . <a href="dlp_v2.projects.locations.columnDataProfiles.html">columnDataProfiles</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets a column data profile.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists column data profiles for an organization.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Gets a column data profile.
98
99 Args:
100 name: string, Required. Resource name, for example `organizations/12345/locations/us/columnDataProfiles/53234423`. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106 Returns:
107 An object of the form:
108
109 { # The profile for a scanned column within a table.
110 &quot;column&quot;: &quot;A String&quot;, # The name of the column.
111 &quot;columnInfoType&quot;: { # The infoType details for this column. # If it&#x27;s been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.
112 &quot;estimatedPrevalence&quot;: 42, # Not populated for predicted infotypes.
113 &quot;infoType&quot;: { # Type of information detected by the API. # The infoType.
114 &quot;name&quot;: &quot;A String&quot;, # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
115 &quot;sensitivityScore&quot;: { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
116 &quot;score&quot;: &quot;A String&quot;, # The sensitivity score applied to the resource.
117 },
118 &quot;version&quot;: &quot;A String&quot;, # Optional version name for this InfoType.
119 },
120 },
121 &quot;columnType&quot;: &quot;A String&quot;, # The data type of a given column.
122 &quot;dataRiskLevel&quot;: { # Score is a summary of all elements in the data profile. A higher number means more risk. # The data risk level for this column.
123 &quot;score&quot;: &quot;A String&quot;, # The score applied to the resource.
124 },
125 &quot;datasetId&quot;: &quot;A String&quot;, # The BigQuery dataset ID, if the resource profiled is a BigQuery table.
126 &quot;datasetLocation&quot;: &quot;A String&quot;, # If supported, the location where the dataset&#x27;s data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.
127 &quot;datasetProjectId&quot;: &quot;A String&quot;, # The Google Cloud project ID that owns the profiled resource.
128 &quot;estimatedNullPercentage&quot;: &quot;A String&quot;, # Approximate percentage of entries being null in the column.
129 &quot;estimatedUniquenessScore&quot;: &quot;A String&quot;, # Approximate uniqueness of the column.
130 &quot;freeTextScore&quot;: 3.14, # The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.
131 &quot;name&quot;: &quot;A String&quot;, # The name of the profile.
132 &quot;otherMatches&quot;: [ # Other types found within this column. List will be unordered.
133 { # Infotype details for other infoTypes found within a column.
134 &quot;estimatedPrevalence&quot;: 42, # Approximate percentage of non-null rows that contained data detected by this infotype.
135 &quot;excludedFromAnalysis&quot;: True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change).
136 &quot;infoType&quot;: { # Type of information detected by the API. # The other infoType.
137 &quot;name&quot;: &quot;A String&quot;, # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
138 &quot;sensitivityScore&quot;: { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
139 &quot;score&quot;: &quot;A String&quot;, # The sensitivity score applied to the resource.
140 },
141 &quot;version&quot;: &quot;A String&quot;, # Optional version name for this InfoType.
142 },
143 },
144 ],
145 &quot;policyState&quot;: &quot;A String&quot;, # Indicates if a policy tag has been applied to the column.
146 &quot;profileLastGenerated&quot;: &quot;A String&quot;, # The last time the profile was generated.
147 &quot;profileStatus&quot;: { # Success or errors for the profile generation. # Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.
148 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Profiling status code and optional message. The `status.code` value is 0 (default value) for OK.
149 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
150 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
151 {
152 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
153 },
154 ],
155 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
156 },
157 &quot;timestamp&quot;: &quot;A String&quot;, # Time when the profile generation status was updated
158 },
159 &quot;sensitivityScore&quot;: { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # The sensitivity of this column.
160 &quot;score&quot;: &quot;A String&quot;, # The sensitivity score applied to the resource.
161 },
162 &quot;state&quot;: &quot;A String&quot;, # State of a profile.
163 &quot;tableDataProfile&quot;: &quot;A String&quot;, # The resource name of the table data profile.
164 &quot;tableFullResource&quot;: &quot;A String&quot;, # The resource name of the resource this column is within.
165 &quot;tableId&quot;: &quot;A String&quot;, # The table ID.
166 }</pre>
167 </div>
168
169 <div class="method">
170 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
171 <pre>Lists column data profiles for an organization.
172
173 Args:
174 parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required)
175 filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `table_data_profile_name`: The name of the related table data profile - `project_id`: The Google Cloud project ID (REQUIRED) - `dataset_id`: The BigQuery dataset ID (REQUIRED) - `table_id`: The BigQuery table ID (REQUIRED) - `field_id`: The ID of the BigQuery field - `info_type`: The infotype detected in the resource - `sensitivity_level`: HIGH|MEDIUM|LOW - `data_risk_level`: How much risk is associated with this data - `status_code`: An RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` for project_id, dataset_id, and table_id. Other filters also support `!=`. The `profile_last_generated` filter also supports `&lt;` and `&gt;`. The syntax is based on https://google.aip.dev/160. Examples: * project_id = 12345 AND status_code = 1 * project_id = 12345 AND sensitivity_level = HIGH * project_id = 12345 AND info_type = STREET_ADDRESS * profile_last_generated &lt; &quot;2025-01-01T00:00:00.000Z&quot; The length of this field should be no more than 500 characters.
176 orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.
177 pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.
178 pageToken: string, Page token to continue retrieval.
179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184 Returns:
185 An object of the form:
186
187 { # List of profiles generated for a given organization or project.
188 &quot;columnDataProfiles&quot;: [ # List of data profiles.
189 { # The profile for a scanned column within a table.
190 &quot;column&quot;: &quot;A String&quot;, # The name of the column.
191 &quot;columnInfoType&quot;: { # The infoType details for this column. # If it&#x27;s been determined this column can be identified as a single type, this will be set. Otherwise the column either has unidentifiable content or mixed types.
192 &quot;estimatedPrevalence&quot;: 42, # Not populated for predicted infotypes.
193 &quot;infoType&quot;: { # Type of information detected by the API. # The infoType.
194 &quot;name&quot;: &quot;A String&quot;, # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
195 &quot;sensitivityScore&quot;: { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
196 &quot;score&quot;: &quot;A String&quot;, # The sensitivity score applied to the resource.
197 },
198 &quot;version&quot;: &quot;A String&quot;, # Optional version name for this InfoType.
199 },
200 },
201 &quot;columnType&quot;: &quot;A String&quot;, # The data type of a given column.
202 &quot;dataRiskLevel&quot;: { # Score is a summary of all elements in the data profile. A higher number means more risk. # The data risk level for this column.
203 &quot;score&quot;: &quot;A String&quot;, # The score applied to the resource.
204 },
205 &quot;datasetId&quot;: &quot;A String&quot;, # The BigQuery dataset ID, if the resource profiled is a BigQuery table.
206 &quot;datasetLocation&quot;: &quot;A String&quot;, # If supported, the location where the dataset&#x27;s data is stored. See https://cloud.google.com/bigquery/docs/locations for supported BigQuery locations.
207 &quot;datasetProjectId&quot;: &quot;A String&quot;, # The Google Cloud project ID that owns the profiled resource.
208 &quot;estimatedNullPercentage&quot;: &quot;A String&quot;, # Approximate percentage of entries being null in the column.
209 &quot;estimatedUniquenessScore&quot;: &quot;A String&quot;, # Approximate uniqueness of the column.
210 &quot;freeTextScore&quot;: 3.14, # The likelihood that this column contains free-form text. A value close to 1 may indicate the column is likely to contain free-form or natural language text. Range in 0-1.
211 &quot;name&quot;: &quot;A String&quot;, # The name of the profile.
212 &quot;otherMatches&quot;: [ # Other types found within this column. List will be unordered.
213 { # Infotype details for other infoTypes found within a column.
214 &quot;estimatedPrevalence&quot;: 42, # Approximate percentage of non-null rows that contained data detected by this infotype.
215 &quot;excludedFromAnalysis&quot;: True or False, # Whether this infoType was excluded from sensitivity and risk analysis due to factors such as low prevalence (subject to change).
216 &quot;infoType&quot;: { # Type of information detected by the API. # The other infoType.
217 &quot;name&quot;: &quot;A String&quot;, # Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference when specifying a built-in type. When sending Cloud DLP results to Data Catalog, infoType names should conform to the pattern `[A-Za-z0-9$_-]{1,64}`.
218 &quot;sensitivityScore&quot;: { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # Optional custom sensitivity for this InfoType. This only applies to data profiling.
219 &quot;score&quot;: &quot;A String&quot;, # The sensitivity score applied to the resource.
220 },
221 &quot;version&quot;: &quot;A String&quot;, # Optional version name for this InfoType.
222 },
223 },
224 ],
225 &quot;policyState&quot;: &quot;A String&quot;, # Indicates if a policy tag has been applied to the column.
226 &quot;profileLastGenerated&quot;: &quot;A String&quot;, # The last time the profile was generated.
227 &quot;profileStatus&quot;: { # Success or errors for the profile generation. # Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.
228 &quot;status&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Profiling status code and optional message. The `status.code` value is 0 (default value) for OK.
229 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
230 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
231 {
232 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
233 },
234 ],
235 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
236 },
237 &quot;timestamp&quot;: &quot;A String&quot;, # Time when the profile generation status was updated
238 },
239 &quot;sensitivityScore&quot;: { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # The sensitivity of this column.
240 &quot;score&quot;: &quot;A String&quot;, # The sensitivity score applied to the resource.
241 },
242 &quot;state&quot;: &quot;A String&quot;, # State of a profile.
243 &quot;tableDataProfile&quot;: &quot;A String&quot;, # The resource name of the table data profile.
244 &quot;tableFullResource&quot;: &quot;A String&quot;, # The resource name of the resource this column is within.
245 &quot;tableId&quot;: &quot;A String&quot;, # The table ID.
246 },
247 ],
248 &quot;nextPageToken&quot;: &quot;A String&quot;, # The next page token.
249 }</pre>
250 </div>
251
252 <div class="method">
253 <code class="details" id="list_next">list_next()</code>
254 <pre>Retrieves the next page of results.
255
256 Args:
257 previous_request: The request for the previous page. (required)
258 previous_response: The response from the request for the previous page. (required)
259
260 Returns:
261 A request object that you can call &#x27;execute()&#x27; on to request the next
262 page. Returns None if there are no more items in the collection.
263 </pre>
264 </div>
265
266 </body></html>