@@ -152,19 +152,20 @@ message DataQualityResult {
152152 [(google.api.field_behavior ) = OUTPUT_ONLY ];
153153 }
154154
155- // Overall data quality result -- `true` if all rules passed.
156- bool passed = 5 ;
155+ // Output only. Overall data quality result -- `true` if all rules passed.
156+ bool passed = 5 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
157157
158158 // Output only. The overall data quality score.
159159 //
160160 // The score ranges between [0, 100] (up to two decimal points).
161161 optional float score = 9 [(google.api.field_behavior ) = OUTPUT_ONLY ];
162162
163- // A list of results at the dimension level.
163+ // Output only. A list of results at the dimension level.
164164 //
165165 // A dimension will have a corresponding `DataQualityDimensionResult` if and
166166 // only if there is at least one rule with the 'dimension' field set to it.
167- repeated DataQualityDimensionResult dimensions = 2 ;
167+ repeated DataQualityDimensionResult dimensions = 2
168+ [(google.api.field_behavior ) = OUTPUT_ONLY ];
168169
169170 // Output only. A list of results at the column level.
170171 //
@@ -173,14 +174,15 @@ message DataQualityResult {
173174 repeated DataQualityColumnResult columns = 10
174175 [(google.api.field_behavior ) = OUTPUT_ONLY ];
175176
176- // A list of all the rules in a job, and their results.
177- repeated DataQualityRuleResult rules = 3 ;
177+ // Output only. A list of all the rules in a job, and their results.
178+ repeated DataQualityRuleResult rules = 3
179+ [(google.api.field_behavior ) = OUTPUT_ONLY ];
178180
179- // The count of rows processed.
180- int64 row_count = 4 ;
181+ // Output only. The count of rows processed.
182+ int64 row_count = 4 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
181183
182- // The data scanned for this result.
183- ScannedData scanned_data = 7 ;
184+ // Output only. The data scanned for this result.
185+ ScannedData scanned_data = 7 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
184186
185187 // Output only. The result of post scan actions.
186188 PostScanActionsResult post_scan_actions_result = 8
@@ -189,13 +191,13 @@ message DataQualityResult {
189191
190192// DataQualityRuleResult provides a more detailed, per-rule view of the results.
191193message DataQualityRuleResult {
192- // The rule specified in the DataQualitySpec, as is.
193- DataQualityRule rule = 1 ;
194+ // Output only. The rule specified in the DataQualitySpec, as is.
195+ DataQualityRule rule = 1 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
194196
195- // Whether the rule passed or failed.
196- bool passed = 7 ;
197+ // Output only. Whether the rule passed or failed.
198+ bool passed = 7 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
197199
198- // The number of rows a rule was evaluated against.
200+ // Output only. The number of rows a rule was evaluated against.
199201 //
200202 // This field is only valid for row-level type rules.
201203 //
@@ -207,23 +209,27 @@ message DataQualityRuleResult {
207209 // `ignore_nulls = true`.
208210 //
209211 // This field is not set for rule SqlAssertion.
210- int64 evaluated_count = 9 ;
212+ int64 evaluated_count = 9 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
211213
214+ // Output only. The number of rows which passed a rule evaluation.
215+ //
216+ // This field is only valid for row-level type rules.
217+ //
212218 // This field is not set for rule SqlAssertion.
213- int64 passed_count = 8 ;
219+ int64 passed_count = 8 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
214220
215- // The number of rows with null values in the specified column.
216- int64 null_count = 5 ;
221+ // Output only. The number of rows with null values in the specified column.
222+ int64 null_count = 5 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
217223
218- // The ratio of **passed_count / evaluated_count**.
224+ // Output only. The ratio of **passed_count / evaluated_count**.
219225 //
220226 // This field is only valid for row-level type rules.
221- double pass_ratio = 6 ;
227+ double pass_ratio = 6 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
222228
223- // The query to find rows that did not pass this rule.
229+ // Output only. The query to find rows that did not pass this rule.
224230 //
225231 // This field is only valid for row-level type rules.
226- string failing_rows_query = 10 ;
232+ string failing_rows_query = 10 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
227233
228234 // Output only. The number of rows returned by the SQL statement in a SQL
229235 // assertion rule.
@@ -239,8 +245,8 @@ message DataQualityDimensionResult {
239245 DataQualityDimension dimension = 1
240246 [(google.api.field_behavior ) = OUTPUT_ONLY ];
241247
242- // Whether the dimension passed or failed.
243- bool passed = 3 ;
248+ // Output only. Whether the dimension passed or failed.
249+ bool passed = 3 [ (google.api .field_behavior ) = OUTPUT_ONLY ] ;
244250
245251 // Output only. The dimension-level data quality score for this data scan job
246252 // if and only if the 'dimension' field is set.
@@ -253,10 +259,9 @@ message DataQualityDimensionResult {
253259// A dimension captures data quality intent about a defined subset of the rules
254260// specified.
255261message DataQualityDimension {
256- // The dimension name a rule belongs to. Supported dimensions are
257- // ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS",
258- // "FRESHNESS", "VOLUME"]
259- string name = 1 ;
262+ // Optional. The dimension name a rule belongs to. Custom dimension name is
263+ // supported with all uppercase letters and maximum length of 30 characters.
264+ string name = 1 [(google.api.field_behavior ) = OPTIONAL ];
260265}
261266
262267// A rule captures data quality intent about a data source.
0 commit comments