Skip to content

Commit 40a290b

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
chore: deprecate SearchEntriesResult.snippets
chore: deprecate SearchEntriesResult.linked_resource docs: clarify DataQualityRule.sql_assertion descriptions docs: fix links to RuleType proto references PiperOrigin-RevId: 642731390
1 parent 247451d commit 40a290b

3 files changed

Lines changed: 38 additions & 35 deletions

File tree

‎google/cloud/dataplex/v1/catalog.proto‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1248,18 +1248,19 @@ message SearchEntriesResult {
12481248
// Snippets for the entry, contains HTML-style highlighting for
12491249
// matched tokens, will be used in UI.
12501250
message Snippets {
1251+
option deprecated = true;
1252+
12511253
// Entry
1252-
Entry dataplex_entry = 1;
1254+
Entry dataplex_entry = 1 [deprecated = true];
12531255
}
12541256

12551257
// Linked resource name.
1256-
string linked_resource = 8;
1258+
string linked_resource = 8 [deprecated = true];
12571259

1258-
// Entry format of the result.
12591260
Entry dataplex_entry = 9;
12601261

12611262
// Snippets.
1262-
Snippets snippets = 12;
1263+
Snippets snippets = 12 [deprecated = true];
12631264
}
12641265

12651266
message SearchEntriesResponse {

‎google/cloud/dataplex/v1/data_quality.proto‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -223,10 +223,10 @@ message DataQualityRuleResult {
223223
// This field is only valid for row-level type rules.
224224
string failing_rows_query = 10;
225225

226-
// Output only. The number of rows returned by the sql statement in the
227-
// SqlAssertion rule.
226+
// Output only. The number of rows returned by the SQL statement in a SQL
227+
// assertion rule.
228228
//
229-
// This field is only valid for SqlAssertion rules.
229+
// This field is only valid for SQL assertion rules.
230230
int64 assertion_row_count = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
231231
}
232232

@@ -370,17 +370,19 @@ message DataQualityRule {
370370
string sql_expression = 1 [(google.api.field_behavior) = OPTIONAL];
371371
}
372372

373-
// Queries for rows returned by the provided SQL statement. If any rows are
374-
// are returned, this rule fails.
373+
// A SQL statement that is evaluated to return rows that match an invalid
374+
// state. If any rows are are returned, this rule fails.
375375
//
376-
// The SQL statement needs to use BigQuery standard SQL syntax, and must not
376+
// The SQL statement must use BigQuery standard SQL syntax, and must not
377377
// contain any semicolons.
378378
//
379-
// ${data()} can be used to reference the rows being evaluated, i.e. the table
380-
// after all additional filters (row filters, incremental data filters,
381-
// sampling) are applied.
379+
// You can use the data reference parameter `${data()}` to reference the
380+
// source table with all of its precondition filters applied. Examples of
381+
// precondition filters include row filters, incremental data filters, and
382+
// sampling. For more information, see [Data reference
383+
// parameter](https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).
382384
//
383-
// Example: SELECT * FROM ${data()} WHERE price < 0
385+
// Example: `SELECT * FROM ${data()} WHERE price < 0`
384386
message SqlAssertion {
385387
// Optional. The SQL statement.
386388
string sql_statement = 1 [(google.api.field_behavior) = OPTIONAL];
@@ -419,7 +421,7 @@ message DataQualityRule {
419421
TableConditionExpectation table_condition_expectation = 201;
420422

421423
// Aggregate rule which evaluates the number of rows returned for the
422-
// provided statement.
424+
// provided statement. If any rows are returned, this rule fails.
423425
SqlAssertion sql_assertion = 202;
424426
}
425427

‎google/cloud/dataplex/v1/logs.proto‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -634,40 +634,40 @@ message DataQualityScanRuleResult {
634634
// An unspecified rule type.
635635
RULE_TYPE_UNSPECIFIED = 0;
636636

637-
// Please see
638-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#nonnullexpectation.
637+
// See
638+
// [DataQualityRule.NonNullExpectation][google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation].
639639
NON_NULL_EXPECTATION = 1;
640640

641-
// Please see
642-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rangeexpectation.
641+
// See
642+
// [DataQualityRule.RangeExpectation][google.cloud.dataplex.v1.DataQualityRule.RangeExpectation].
643643
RANGE_EXPECTATION = 2;
644644

645-
// Please see
646-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#regexexpectation.
645+
// See
646+
// [DataQualityRule.RegexExpectation][google.cloud.dataplex.v1.DataQualityRule.RegexExpectation].
647647
REGEX_EXPECTATION = 3;
648648

649-
// Please see
650-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rowconditionexpectation.
649+
// See
650+
// [DataQualityRule.RowConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation].
651651
ROW_CONDITION_EXPECTATION = 4;
652652

653-
// Please see
654-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#setexpectation.
653+
// See
654+
// [DataQualityRule.SetExpectation][google.cloud.dataplex.v1.DataQualityRule.SetExpectation].
655655
SET_EXPECTATION = 5;
656656

657-
// Please see
658-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#statisticrangeexpectation.
657+
// See
658+
// [DataQualityRule.StatisticRangeExpectation][google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation].
659659
STATISTIC_RANGE_EXPECTATION = 6;
660660

661-
// Please see
662-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#tableconditionexpectation.
661+
// See
662+
// [DataQualityRule.TableConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation].
663663
TABLE_CONDITION_EXPECTATION = 7;
664664

665-
// Please see
666-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#uniquenessexpectation.
665+
// See
666+
// [DataQualityRule.UniquenessExpectation][google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation].
667667
UNIQUENESS_EXPECTATION = 8;
668668

669-
// Please see
670-
// https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#sqlAssertion.
669+
// See
670+
// [DataQualityRule.SqlAssertion][google.cloud.dataplex.v1.DataQualityRule.SqlAssertion].
671671
SQL_ASSERTION = 9;
672672
}
673673

@@ -733,7 +733,7 @@ message DataQualityScanRuleResult {
733733
// The number of rows with null values in the specified column.
734734
int64 null_row_count = 12;
735735

736-
// The number of rows returned by the sql statement in the SqlAssertion rule.
737-
// This field is only valid for SqlAssertion rules.
736+
// The number of rows returned by the SQL statement in a SQL assertion rule.
737+
// This field is only valid for SQL assertion rules.
738738
int64 assertion_row_count = 13;
739739
}

0 commit comments

Comments
 (0)