Skip to content

Commit

Permalink
chore: [google-cloud-dataplex] deprecate SearchEntriesResult.snippets (
Browse files Browse the repository at this point in the history
…#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:
googleapis/googleapis-gen@2e95263
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFwbGV4Ly5Pd2xCb3QueWFtbCIsImgiOiIyZTk1MjYzZmRjNzA3ZDRiY2ViNzMxMGVlNWVhYzA5MTliMGE0M2MyIn0=

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <omairnaveed@ymail.com>
  • Loading branch information
3 people committed Jun 18, 2024
1 parent 319d012 commit 74db0f8
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1848,7 +1848,7 @@ class SearchEntriesResult(proto.Message):
linked_resource (str):
Linked resource name.
dataplex_entry (google.cloud.dataplex_v1.types.Entry):
Entry format of the result.
snippets (google.cloud.dataplex_v1.types.SearchEntriesResult.Snippets):
Snippets.
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -384,9 +384,10 @@ class DataQualityRuleResult(proto.Message):
rules.
assertion_row_count (int):
Output only. The number of rows returned by
the sql statement in the SqlAssertion rule.
the SQL statement in a SQL assertion rule.
This field is only valid for SqlAssertion rules.
This field is only valid for SQL assertion
rules.
"""

rule: "DataQualityRule" = proto.Field(
Expand Down Expand Up @@ -534,7 +535,8 @@ class DataQualityRule(proto.Message):
This field is a member of `oneof`_ ``rule_type``.
sql_assertion (google.cloud.dataplex_v1.types.DataQualityRule.SqlAssertion):
Aggregate rule which evaluates the number of
rows returned for the provided statement.
rows returned for the provided statement. If any
rows are returned, this rule fails.
This field is a member of `oneof`_ ``rule_type``.
column (str):
Expand Down Expand Up @@ -770,17 +772,20 @@ class TableConditionExpectation(proto.Message):
)

class SqlAssertion(proto.Message):
r"""Queries for rows returned by the provided SQL statement. If any rows
are are returned, this rule fails.
r"""A SQL statement that is evaluated to return rows that match an
invalid state. If any rows are are returned, this rule fails.
The SQL statement needs to use BigQuery standard SQL syntax, and
must not contain any semicolons.
The SQL statement must use BigQuery standard SQL syntax, and must
not contain any semicolons.
${data()} can be used to reference the rows being evaluated, i.e.
the table after all additional filters (row filters, incremental
data filters, sampling) are applied.
You can use the data reference parameter ``${data()}`` to reference
the source table with all of its precondition filters applied.
Examples of precondition filters include row filters, incremental
data filters, and sampling. For more information, see `Data
reference
parameter <https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter>`__.
Example: SELECT \* FROM ${data()} WHERE price < 0
Example: ``SELECT * FROM ${data()} WHERE price < 0``
Attributes:
sql_statement (str):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1138,9 +1138,9 @@ class DataQualityScanRuleResult(proto.Message):
The number of rows with null values in the
specified column.
assertion_row_count (int):
The number of rows returned by the sql
statement in the SqlAssertion rule. This field
is only valid for SqlAssertion rules.
The number of rows returned by the SQL
statement in a SQL assertion rule. This field is
only valid for SQL assertion rules.
"""

class RuleType(proto.Enum):
Expand All @@ -1150,32 +1150,32 @@ class RuleType(proto.Enum):
RULE_TYPE_UNSPECIFIED (0):
An unspecified rule type.
NON_NULL_EXPECTATION (1):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#nonnullexpectation.
See
[DataQualityRule.NonNullExpectation][google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation].
RANGE_EXPECTATION (2):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rangeexpectation.
See
[DataQualityRule.RangeExpectation][google.cloud.dataplex.v1.DataQualityRule.RangeExpectation].
REGEX_EXPECTATION (3):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#regexexpectation.
See
[DataQualityRule.RegexExpectation][google.cloud.dataplex.v1.DataQualityRule.RegexExpectation].
ROW_CONDITION_EXPECTATION (4):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rowconditionexpectation.
See
[DataQualityRule.RowConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation].
SET_EXPECTATION (5):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#setexpectation.
See
[DataQualityRule.SetExpectation][google.cloud.dataplex.v1.DataQualityRule.SetExpectation].
STATISTIC_RANGE_EXPECTATION (6):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#statisticrangeexpectation.
See
[DataQualityRule.StatisticRangeExpectation][google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation].
TABLE_CONDITION_EXPECTATION (7):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#tableconditionexpectation.
See
[DataQualityRule.TableConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation].
UNIQUENESS_EXPECTATION (8):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#uniquenessexpectation.
See
[DataQualityRule.UniquenessExpectation][google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation].
SQL_ASSERTION (9):
Please see
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#sqlAssertion.
See
[DataQualityRule.SqlAssertion][google.cloud.dataplex.v1.DataQualityRule.SqlAssertion].
"""
RULE_TYPE_UNSPECIFIED = 0
NON_NULL_EXPECTATION = 1
Expand Down

0 comments on commit 74db0f8

Please sign in to comment.