Skip to content

Commit 74db0f8

Browse files
gcf-owl-bot[bot]ohmayr
gcf-owl-bot[bot]
and
ohmayr
authored
chore: [google-cloud-dataplex] deprecate SearchEntriesResult.snippets (googleapis#12800)
BEGIN_COMMIT_OVERRIDE chore: deprecate SearchEntriesResult.snippets chore: deprecate SearchEntriesResult.linked_resource docs: clarify DataQualityRule.sql_assertion descriptions docs: fix links to RuleType proto references END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. chore: deprecate SearchEntriesResult.linked_resource docs: clarify DataQualityRule.sql_assertion descriptions docs: fix links to RuleType proto references PiperOrigin-RevId: 642731390 Source-Link: googleapis/googleapis@40a290b Source-Link: https://github.com/googleapis/googleapis-gen/commit/2e95263fdc707d4bceb7310ee5eac0919b0a43c2 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFwbGV4Ly5Pd2xCb3QueWFtbCIsImgiOiIyZTk1MjYzZmRjNzA3ZDRiY2ViNzMxMGVlNWVhYzA5MTliMGE0M2MyIn0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: ohmayr <omairnaveed@ymail.com>
1 parent 319d012 commit 74db0f8

3 files changed

Lines changed: 38 additions & 33 deletions

File tree

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/catalog.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1848,7 +1848,7 @@ class SearchEntriesResult(proto.Message):
18481848
linked_resource (str):
18491849
Linked resource name.
18501850
dataplex_entry (google.cloud.dataplex_v1.types.Entry):
1851-
Entry format of the result.
1851+
18521852
snippets (google.cloud.dataplex_v1.types.SearchEntriesResult.Snippets):
18531853
Snippets.
18541854
"""

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/data_quality.py‎

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -384,9 +384,10 @@ class DataQualityRuleResult(proto.Message):
384384
rules.
385385
assertion_row_count (int):
386386
Output only. The number of rows returned by
387-
the sql statement in the SqlAssertion rule.
387+
the SQL statement in a SQL assertion rule.
388388
389-
This field is only valid for SqlAssertion rules.
389+
This field is only valid for SQL assertion
390+
rules.
390391
"""
391392

392393
rule: "DataQualityRule" = proto.Field(
@@ -534,7 +535,8 @@ class DataQualityRule(proto.Message):
534535
This field is a member of `oneof`_ ``rule_type``.
535536
sql_assertion (google.cloud.dataplex_v1.types.DataQualityRule.SqlAssertion):
536537
Aggregate rule which evaluates the number of
537-
rows returned for the provided statement.
538+
rows returned for the provided statement. If any
539+
rows are returned, this rule fails.
538540
539541
This field is a member of `oneof`_ ``rule_type``.
540542
column (str):
@@ -770,17 +772,20 @@ class TableConditionExpectation(proto.Message):
770772
)
771773

772774
class SqlAssertion(proto.Message):
773-
r"""Queries for rows returned by the provided SQL statement. If any rows
774-
are are returned, this rule fails.
775+
r"""A SQL statement that is evaluated to return rows that match an
776+
invalid state. If any rows are are returned, this rule fails.
775777
776-
The SQL statement needs to use BigQuery standard SQL syntax, and
777-
must not contain any semicolons.
778+
The SQL statement must use BigQuery standard SQL syntax, and must
779+
not contain any semicolons.
778780
779-
${data()} can be used to reference the rows being evaluated, i.e.
780-
the table after all additional filters (row filters, incremental
781-
data filters, sampling) are applied.
781+
You can use the data reference parameter ``${data()}`` to reference
782+
the source table with all of its precondition filters applied.
783+
Examples of precondition filters include row filters, incremental
784+
data filters, and sampling. For more information, see `Data
785+
reference
786+
parameter <https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter>`__.
782787
783-
Example: SELECT \* FROM ${data()} WHERE price < 0
788+
Example: ``SELECT * FROM ${data()} WHERE price < 0``
784789
785790
Attributes:
786791
sql_statement (str):

‎packages/google-cloud-dataplex/google/cloud/dataplex_v1/types/logs.py‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1138,9 +1138,9 @@ class DataQualityScanRuleResult(proto.Message):
11381138
The number of rows with null values in the
11391139
specified column.
11401140
assertion_row_count (int):
1141-
The number of rows returned by the sql
1142-
statement in the SqlAssertion rule. This field
1143-
is only valid for SqlAssertion rules.
1141+
The number of rows returned by the SQL
1142+
statement in a SQL assertion rule. This field is
1143+
only valid for SQL assertion rules.
11441144
"""
11451145

11461146
class RuleType(proto.Enum):
@@ -1150,32 +1150,32 @@ class RuleType(proto.Enum):
11501150
RULE_TYPE_UNSPECIFIED (0):
11511151
An unspecified rule type.
11521152
NON_NULL_EXPECTATION (1):
1153-
Please see
1154-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#nonnullexpectation.
1153+
See
1154+
[DataQualityRule.NonNullExpectation][google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation].
11551155
RANGE_EXPECTATION (2):
1156-
Please see
1157-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rangeexpectation.
1156+
See
1157+
[DataQualityRule.RangeExpectation][google.cloud.dataplex.v1.DataQualityRule.RangeExpectation].
11581158
REGEX_EXPECTATION (3):
1159-
Please see
1160-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#regexexpectation.
1159+
See
1160+
[DataQualityRule.RegexExpectation][google.cloud.dataplex.v1.DataQualityRule.RegexExpectation].
11611161
ROW_CONDITION_EXPECTATION (4):
1162-
Please see
1163-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rowconditionexpectation.
1162+
See
1163+
[DataQualityRule.RowConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation].
11641164
SET_EXPECTATION (5):
1165-
Please see
1166-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#setexpectation.
1165+
See
1166+
[DataQualityRule.SetExpectation][google.cloud.dataplex.v1.DataQualityRule.SetExpectation].
11671167
STATISTIC_RANGE_EXPECTATION (6):
1168-
Please see
1169-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#statisticrangeexpectation.
1168+
See
1169+
[DataQualityRule.StatisticRangeExpectation][google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation].
11701170
TABLE_CONDITION_EXPECTATION (7):
1171-
Please see
1172-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#tableconditionexpectation.
1171+
See
1172+
[DataQualityRule.TableConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation].
11731173
UNIQUENESS_EXPECTATION (8):
1174-
Please see
1175-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#uniquenessexpectation.
1174+
See
1175+
[DataQualityRule.UniquenessExpectation][google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation].
11761176
SQL_ASSERTION (9):
1177-
Please see
1178-
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#sqlAssertion.
1177+
See
1178+
[DataQualityRule.SqlAssertion][google.cloud.dataplex.v1.DataQualityRule.SqlAssertion].
11791179
"""
11801180
RULE_TYPE_UNSPECIFIED = 0
11811181
NON_NULL_EXPECTATION = 1

0 commit comments

Comments
 (0)