From 55227ad314a515750e44061fdc9e9f52a0353501 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 20 Jun 2024 14:18:50 -0700 Subject: [PATCH] chore: deprecate SearchEntriesResult.snippets (#7419) chore: deprecate SearchEntriesResult.linked_resource docs: clarify DataQualityRule.sql_assertion descriptions docs: fix links to RuleType proto references PiperOrigin-RevId: 642731390 Source-Link: https://github.com/googleapis/googleapis/commit/40a290b20d6bf83e60fb32f7f5349ac92fff4825 Source-Link: https://github.com/googleapis/googleapis-gen/commit/2e95263fdc707d4bceb7310ee5eac0919b0a43c2 Copy-Tag: eyJwIjoiRGF0YXBsZXgvLk93bEJvdC55YW1sIiwiaCI6IjJlOTUyNjNmZGM3MDdkNGJjZWI3MzEwZWU1ZWFjMDkxOWIwYTQzYzIifQ== --- Dataplex/metadata/V1/Catalog.php | 21 ++++---- .../generate_data_quality_rules.php | 15 ++++-- .../src/V1/Client/DataScanServiceClient.php | 5 +- Dataplex/src/V1/DataQualityRule.php | 6 +-- .../src/V1/DataQualityRule/SqlAssertion.php | 16 ++++--- Dataplex/src/V1/DataQualityRuleResult.php | 24 +++++----- Dataplex/src/V1/DataQualityScanRuleResult.php | 16 +++---- .../V1/DataQualityScanRuleResult/RuleType.php | 36 +++++++------- Dataplex/src/V1/EntrySource.php | 46 ++++++++++++++++++ .../V1/GenerateDataQualityRulesRequest.php | 48 +++++++++++-------- .../V1/GenerateDataQualityRulesResponse.php | 14 ++++-- Dataplex/src/V1/SearchEntriesResult.php | 31 +++++++----- .../src/V1/SearchEntriesResult/Snippets.php | 14 ++++-- 13 files changed, 186 insertions(+), 106 deletions(-) diff --git a/Dataplex/metadata/V1/Catalog.php b/Dataplex/metadata/V1/Catalog.php index cf7ececbce98..96c8b3161408 100644 --- a/Dataplex/metadata/V1/Catalog.php +++ b/Dataplex/metadata/V1/Catalog.php @@ -26,7 +26,7 @@ public static function initOnce() { \GPBMetadata\Google\Protobuf\Timestamp::initOnce(); $pool->internalAddGeneratedFile( ' -În +õn &google/cloud/dataplex/v1/catalog.protogoogle.cloud.dataplex.v1google/api/client.protogoogle/api/field_behavior.protogoogle/api/resource.proto&google/cloud/dataplex/v1/service.proto#google/longrunning/operations.protogoogle/protobuf/empty.proto google/protobuf/field_mask.protogoogle/protobuf/struct.protogoogle/protobuf/timestamp.proto"Ó AspectType8 @@ -146,7 +146,7 @@ public static function initOnce() { AspectsEntry key ( / value ( 2 .google.cloud.dataplex.v1.Aspect:8:†êA‚ -dataplex.googleapis.com/EntryQprojects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}*entries2entry"º +dataplex.googleapis.com/EntryQprojects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}*entries2entry"Ñ EntrySource resource (  system (  @@ -157,7 +157,8 @@ public static function initOnce() { ancestors ( 2..google.cloud.dataplex.v1.EntrySource.AncestorBàA/ create_time ( 2.google.protobuf.Timestamp/ - update_time ( 2.google.protobuf.Timestamp0 + update_time ( 2.google.protobuf.Timestamp +location ( BàA0 Ancestor name ( BàA type ( BàA- @@ -297,13 +298,13 @@ public static function initOnce() { page_token ( BàA order_by ( BàA -scope ( BàA"ö -SearchEntriesResult -linked_resource ( 7 -dataplex_entry ( 2.google.cloud.dataplex.v1.EntryH -snippets ( 26.google.cloud.dataplex.v1.SearchEntriesResult.SnippetsC -Snippets7 -dataplex_entry ( 2.google.cloud.dataplex.v1.Entry"™ +scope ( BàA"† +SearchEntriesResult +linked_resource ( B7 +dataplex_entry ( 2.google.cloud.dataplex.v1.EntryL +snippets ( 26.google.cloud.dataplex.v1.SearchEntriesResult.SnippetsBK +Snippets; +dataplex_entry ( 2.google.cloud.dataplex.v1.EntryB:"™ SearchEntriesResponse> results ( 2-.google.cloud.dataplex.v1.SearchEntriesResult diff --git a/Dataplex/samples/V1/DataScanServiceClient/generate_data_quality_rules.php b/Dataplex/samples/V1/DataScanServiceClient/generate_data_quality_rules.php index e522ad830756..a924abc0f9a5 100644 --- a/Dataplex/samples/V1/DataScanServiceClient/generate_data_quality_rules.php +++ b/Dataplex/samples/V1/DataScanServiceClient/generate_data_quality_rules.php @@ -29,12 +29,17 @@ use Google\Cloud\Dataplex\V1\GenerateDataQualityRulesResponse; /** - * Generates recommended DataQualityRule from a data profiling DataScan. + * Generates recommended data quality rules based on the results of a data + * profiling scan. * - * @param string $name The name should be either - * * the name of a datascan with at least one successful completed data - * profiling job, or - * * the name of a successful completed data profiling datascan job. + * Use the recommendations to build rules for a data quality scan. + * + * @param string $name The name must be one of the following: + * + * * The name of a data scan with at least one successful, completed data + * profiling job + * * The name of a successful, completed data profiling job (a data scan job + * where the job type is data profiling) */ function generate_data_quality_rules_sample(string $name): void { diff --git a/Dataplex/src/V1/Client/DataScanServiceClient.php b/Dataplex/src/V1/Client/DataScanServiceClient.php index d7aea8c542ca..68ff93659909 100644 --- a/Dataplex/src/V1/Client/DataScanServiceClient.php +++ b/Dataplex/src/V1/Client/DataScanServiceClient.php @@ -422,7 +422,10 @@ public function deleteDataScan(DeleteDataScanRequest $request, array $callOption } /** - * Generates recommended DataQualityRule from a data profiling DataScan. + * Generates recommended data quality rules based on the results of a data + * profiling scan. + * + * Use the recommendations to build rules for a data quality scan. * * The async variant is * {@see DataScanServiceClient::generateDataQualityRulesAsync()} . diff --git a/Dataplex/src/V1/DataQualityRule.php b/Dataplex/src/V1/DataQualityRule.php index e280573c33cc..d473f813099a 100644 --- a/Dataplex/src/V1/DataQualityRule.php +++ b/Dataplex/src/V1/DataQualityRule.php @@ -101,7 +101,7 @@ class DataQualityRule extends \Google\Protobuf\Internal\Message * for a table. * @type \Google\Cloud\Dataplex\V1\DataQualityRule\SqlAssertion $sql_assertion * Aggregate rule which evaluates the number of rows returned for the - * provided statement. + * provided statement. If any rows are returned, this rule fails. * @type string $column * Optional. The unnested column which this rule is evaluated against. * @type bool $ignore_null @@ -401,7 +401,7 @@ public function setTableConditionExpectation($var) /** * Aggregate rule which evaluates the number of rows returned for the - * provided statement. + * provided statement. If any rows are returned, this rule fails. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202; * @return \Google\Cloud\Dataplex\V1\DataQualityRule\SqlAssertion|null @@ -418,7 +418,7 @@ public function hasSqlAssertion() /** * Aggregate rule which evaluates the number of rows returned for the - * provided statement. + * provided statement. If any rows are returned, this rule fails. * * Generated from protobuf field .google.cloud.dataplex.v1.DataQualityRule.SqlAssertion sql_assertion = 202; * @param \Google\Cloud\Dataplex\V1\DataQualityRule\SqlAssertion $var diff --git a/Dataplex/src/V1/DataQualityRule/SqlAssertion.php b/Dataplex/src/V1/DataQualityRule/SqlAssertion.php index ee9606c88a33..b7030d1d4f2d 100644 --- a/Dataplex/src/V1/DataQualityRule/SqlAssertion.php +++ b/Dataplex/src/V1/DataQualityRule/SqlAssertion.php @@ -9,14 +9,16 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Queries for rows returned by the provided SQL statement. If any rows are - * are returned, this rule fails. - * The SQL statement needs to use BigQuery standard SQL syntax, and must not + * 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 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. - * Example: SELECT * FROM ${data()} WHERE price < 0 + * 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` * * Generated from protobuf message google.cloud.dataplex.v1.DataQualityRule.SqlAssertion */ diff --git a/Dataplex/src/V1/DataQualityRuleResult.php b/Dataplex/src/V1/DataQualityRuleResult.php index 99064fea716c..920cbd79ef56 100644 --- a/Dataplex/src/V1/DataQualityRuleResult.php +++ b/Dataplex/src/V1/DataQualityRuleResult.php @@ -67,9 +67,9 @@ class DataQualityRuleResult extends \Google\Protobuf\Internal\Message */ protected $failing_rows_query = ''; /** - * Output only. The number of rows returned by the sql statement in the - * SqlAssertion rule. - * This field is only valid for SqlAssertion rules. + * Output only. The number of rows returned by the SQL statement in a SQL + * assertion rule. + * This field is only valid for SQL assertion rules. * * Generated from protobuf field int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ @@ -105,9 +105,9 @@ class DataQualityRuleResult extends \Google\Protobuf\Internal\Message * The query to find rows that did not pass this rule. * This field is only valid for row-level type rules. * @type int|string $assertion_row_count - * Output only. The number of rows returned by the sql statement in the - * SqlAssertion rule. - * This field is only valid for SqlAssertion rules. + * Output only. The number of rows returned by the SQL statement in a SQL + * assertion rule. + * This field is only valid for SQL assertion rules. * } */ public function __construct($data = NULL) { @@ -326,9 +326,9 @@ public function setFailingRowsQuery($var) } /** - * Output only. The number of rows returned by the sql statement in the - * SqlAssertion rule. - * This field is only valid for SqlAssertion rules. + * Output only. The number of rows returned by the SQL statement in a SQL + * assertion rule. + * This field is only valid for SQL assertion rules. * * Generated from protobuf field int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @return int|string @@ -339,9 +339,9 @@ public function getAssertionRowCount() } /** - * Output only. The number of rows returned by the sql statement in the - * SqlAssertion rule. - * This field is only valid for SqlAssertion rules. + * Output only. The number of rows returned by the SQL statement in a SQL + * assertion rule. + * This field is only valid for SQL assertion rules. * * Generated from protobuf field int64 assertion_row_count = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; * @param int|string $var diff --git a/Dataplex/src/V1/DataQualityScanRuleResult.php b/Dataplex/src/V1/DataQualityScanRuleResult.php index 92c79c3b1cd7..5e3e344e79d2 100644 --- a/Dataplex/src/V1/DataQualityScanRuleResult.php +++ b/Dataplex/src/V1/DataQualityScanRuleResult.php @@ -91,8 +91,8 @@ class DataQualityScanRuleResult extends \Google\Protobuf\Internal\Message */ protected $null_row_count = 0; /** - * 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. * * Generated from protobuf field int64 assertion_row_count = 13; */ @@ -131,8 +131,8 @@ class DataQualityScanRuleResult extends \Google\Protobuf\Internal\Message * @type int|string $null_row_count * The number of rows with null values in the specified column. * @type int|string $assertion_row_count - * 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. * } */ public function __construct($data = NULL) { @@ -457,8 +457,8 @@ public function setNullRowCount($var) } /** - * 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. * * Generated from protobuf field int64 assertion_row_count = 13; * @return int|string @@ -469,8 +469,8 @@ public function getAssertionRowCount() } /** - * 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. * * Generated from protobuf field int64 assertion_row_count = 13; * @param int|string $var diff --git a/Dataplex/src/V1/DataQualityScanRuleResult/RuleType.php b/Dataplex/src/V1/DataQualityScanRuleResult/RuleType.php index 51434ffb5c35..8513969e2df6 100644 --- a/Dataplex/src/V1/DataQualityScanRuleResult/RuleType.php +++ b/Dataplex/src/V1/DataQualityScanRuleResult/RuleType.php @@ -20,64 +20,64 @@ class RuleType */ const RULE_TYPE_UNSPECIFIED = 0; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#nonnullexpectation. + * See + * [DataQualityRule.NonNullExpectation][google.cloud.dataplex.v1.DataQualityRule.NonNullExpectation]. * * Generated from protobuf enum NON_NULL_EXPECTATION = 1; */ const NON_NULL_EXPECTATION = 1; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rangeexpectation. + * See + * [DataQualityRule.RangeExpectation][google.cloud.dataplex.v1.DataQualityRule.RangeExpectation]. * * Generated from protobuf enum RANGE_EXPECTATION = 2; */ const RANGE_EXPECTATION = 2; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#regexexpectation. + * See + * [DataQualityRule.RegexExpectation][google.cloud.dataplex.v1.DataQualityRule.RegexExpectation]. * * Generated from protobuf enum REGEX_EXPECTATION = 3; */ const REGEX_EXPECTATION = 3; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#rowconditionexpectation. + * See + * [DataQualityRule.RowConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.RowConditionExpectation]. * * Generated from protobuf enum ROW_CONDITION_EXPECTATION = 4; */ const ROW_CONDITION_EXPECTATION = 4; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#setexpectation. + * See + * [DataQualityRule.SetExpectation][google.cloud.dataplex.v1.DataQualityRule.SetExpectation]. * * Generated from protobuf enum SET_EXPECTATION = 5; */ const SET_EXPECTATION = 5; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#statisticrangeexpectation. + * See + * [DataQualityRule.StatisticRangeExpectation][google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation]. * * Generated from protobuf enum STATISTIC_RANGE_EXPECTATION = 6; */ const STATISTIC_RANGE_EXPECTATION = 6; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#tableconditionexpectation. + * See + * [DataQualityRule.TableConditionExpectation][google.cloud.dataplex.v1.DataQualityRule.TableConditionExpectation]. * * Generated from protobuf enum TABLE_CONDITION_EXPECTATION = 7; */ const TABLE_CONDITION_EXPECTATION = 7; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#uniquenessexpectation. + * See + * [DataQualityRule.UniquenessExpectation][google.cloud.dataplex.v1.DataQualityRule.UniquenessExpectation]. * * Generated from protobuf enum UNIQUENESS_EXPECTATION = 8; */ const UNIQUENESS_EXPECTATION = 8; /** - * Please see - * https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualityRule#sqlAssertion. + * See + * [DataQualityRule.SqlAssertion][google.cloud.dataplex.v1.DataQualityRule.SqlAssertion]. * * Generated from protobuf enum SQL_ASSERTION = 9; */ diff --git a/Dataplex/src/V1/EntrySource.php b/Dataplex/src/V1/EntrySource.php index 6560291d3978..9ad43ede8e01 100644 --- a/Dataplex/src/V1/EntrySource.php +++ b/Dataplex/src/V1/EntrySource.php @@ -76,6 +76,15 @@ class EntrySource extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp update_time = 11; */ protected $update_time = null; + /** + * Output only. Location of the resource in the source system. Entry will be + * searchable by this location. By default, this should match the location of + * the EntryGroup containing this entry. A different value allows capturing + * source location for data external to GCP. + * + * Generated from protobuf field string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + protected $location = ''; /** * Constructor. @@ -107,6 +116,11 @@ class EntrySource extends \Google\Protobuf\Internal\Message * The create time of the resource in the source system. * @type \Google\Protobuf\Timestamp $update_time * The update time of the resource in the source system. + * @type string $location + * Output only. Location of the resource in the source system. Entry will be + * searchable by this location. By default, this should match the location of + * the EntryGroup containing this entry. A different value allows capturing + * source location for data external to GCP. * } */ public function __construct($data = NULL) { @@ -380,5 +394,37 @@ public function setUpdateTime($var) return $this; } + /** + * Output only. Location of the resource in the source system. Entry will be + * searchable by this location. By default, this should match the location of + * the EntryGroup containing this entry. A different value allows capturing + * source location for data external to GCP. + * + * Generated from protobuf field string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return string + */ + public function getLocation() + { + return $this->location; + } + + /** + * Output only. Location of the resource in the source system. Entry will be + * searchable by this location. By default, this should match the location of + * the EntryGroup containing this entry. A different value allows capturing + * source location for data external to GCP. + * + * Generated from protobuf field string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param string $var + * @return $this + */ + public function setLocation($var) + { + GPBUtil::checkString($var, True); + $this->location = $var; + + return $this; + } + } diff --git a/Dataplex/src/V1/GenerateDataQualityRulesRequest.php b/Dataplex/src/V1/GenerateDataQualityRulesRequest.php index 1d3444f890b8..cb27ebf62bbc 100644 --- a/Dataplex/src/V1/GenerateDataQualityRulesRequest.php +++ b/Dataplex/src/V1/GenerateDataQualityRulesRequest.php @@ -9,27 +9,30 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Generate recommended DataQualityRules request. + * Request details for generating data quality rule recommendations. * * Generated from protobuf message google.cloud.dataplex.v1.GenerateDataQualityRulesRequest */ class GenerateDataQualityRulesRequest extends \Google\Protobuf\Internal\Message { /** - * Required. The name should be either - * * the name of a datascan with at least one successful completed data - * profiling job, or - * * the name of a successful completed data profiling datascan job. + * Required. The name must be one of the following: + * * The name of a data scan with at least one successful, completed data + * profiling job + * * The name of a successful, completed data profiling job (a data scan job + * where the job type is data profiling) * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; */ protected $name = ''; /** - * @param string $name Required. The name should be either - * * the name of a datascan with at least one successful completed data - * profiling job, or - * * the name of a successful completed data profiling datascan job. + * @param string $name Required. The name must be one of the following: + * + * * The name of a data scan with at least one successful, completed data + * profiling job + * * The name of a successful, completed data profiling job (a data scan job + * where the job type is data profiling) * * @return \Google\Cloud\Dataplex\V1\GenerateDataQualityRulesRequest * @@ -48,10 +51,11 @@ public static function build(string $name): self * Optional. Data for populating the Message object. * * @type string $name - * Required. The name should be either - * * the name of a datascan with at least one successful completed data - * profiling job, or - * * the name of a successful completed data profiling datascan job. + * Required. The name must be one of the following: + * * The name of a data scan with at least one successful, completed data + * profiling job + * * The name of a successful, completed data profiling job (a data scan job + * where the job type is data profiling) * } */ public function __construct($data = NULL) { @@ -60,10 +64,11 @@ public function __construct($data = NULL) { } /** - * Required. The name should be either - * * the name of a datascan with at least one successful completed data - * profiling job, or - * * the name of a successful completed data profiling datascan job. + * Required. The name must be one of the following: + * * The name of a data scan with at least one successful, completed data + * profiling job + * * The name of a successful, completed data profiling job (a data scan job + * where the job type is data profiling) * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string @@ -74,10 +79,11 @@ public function getName() } /** - * Required. The name should be either - * * the name of a datascan with at least one successful completed data - * profiling job, or - * * the name of a successful completed data profiling datascan job. + * Required. The name must be one of the following: + * * The name of a data scan with at least one successful, completed data + * profiling job + * * The name of a successful, completed data profiling job (a data scan job + * where the job type is data profiling) * * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var diff --git a/Dataplex/src/V1/GenerateDataQualityRulesResponse.php b/Dataplex/src/V1/GenerateDataQualityRulesResponse.php index fa442d91bab0..5c3181e91d63 100644 --- a/Dataplex/src/V1/GenerateDataQualityRulesResponse.php +++ b/Dataplex/src/V1/GenerateDataQualityRulesResponse.php @@ -9,14 +9,15 @@ use Google\Protobuf\Internal\GPBUtil; /** - * Generate recommended DataQualityRules response. + * Response details for data quality rule recommendations. * * Generated from protobuf message google.cloud.dataplex.v1.GenerateDataQualityRulesResponse */ class GenerateDataQualityRulesResponse extends \Google\Protobuf\Internal\Message { /** - * Generated recommended {@link DataQualityRule}s. + * The data quality rules that Dataplex generates based on the results + * of a data profiling scan. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.DataQualityRule rule = 1; */ @@ -29,7 +30,8 @@ class GenerateDataQualityRulesResponse extends \Google\Protobuf\Internal\Message * Optional. Data for populating the Message object. * * @type array<\Google\Cloud\Dataplex\V1\DataQualityRule>|\Google\Protobuf\Internal\RepeatedField $rule - * Generated recommended {@link DataQualityRule}s. + * The data quality rules that Dataplex generates based on the results + * of a data profiling scan. * } */ public function __construct($data = NULL) { @@ -38,7 +40,8 @@ public function __construct($data = NULL) { } /** - * Generated recommended {@link DataQualityRule}s. + * The data quality rules that Dataplex generates based on the results + * of a data profiling scan. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.DataQualityRule rule = 1; * @return \Google\Protobuf\Internal\RepeatedField @@ -49,7 +52,8 @@ public function getRule() } /** - * Generated recommended {@link DataQualityRule}s. + * The data quality rules that Dataplex generates based on the results + * of a data profiling scan. * * Generated from protobuf field repeated .google.cloud.dataplex.v1.DataQualityRule rule = 1; * @param array<\Google\Cloud\Dataplex\V1\DataQualityRule>|\Google\Protobuf\Internal\RepeatedField $var diff --git a/Dataplex/src/V1/SearchEntriesResult.php b/Dataplex/src/V1/SearchEntriesResult.php index 2466072d3f0a..da38944cb361 100644 --- a/Dataplex/src/V1/SearchEntriesResult.php +++ b/Dataplex/src/V1/SearchEntriesResult.php @@ -18,19 +18,19 @@ class SearchEntriesResult extends \Google\Protobuf\Internal\Message /** * Linked resource name. * - * Generated from protobuf field string linked_resource = 8; + * Generated from protobuf field string linked_resource = 8 [deprecated = true]; + * @deprecated */ protected $linked_resource = ''; /** - * Entry format of the result. - * * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 9; */ protected $dataplex_entry = null; /** * Snippets. * - * Generated from protobuf field .google.cloud.dataplex.v1.SearchEntriesResult.Snippets snippets = 12; + * Generated from protobuf field .google.cloud.dataplex.v1.SearchEntriesResult.Snippets snippets = 12 [deprecated = true]; + * @deprecated */ protected $snippets = null; @@ -43,7 +43,6 @@ class SearchEntriesResult extends \Google\Protobuf\Internal\Message * @type string $linked_resource * Linked resource name. * @type \Google\Cloud\Dataplex\V1\Entry $dataplex_entry - * Entry format of the result. * @type \Google\Cloud\Dataplex\V1\SearchEntriesResult\Snippets $snippets * Snippets. * } @@ -56,23 +55,27 @@ public function __construct($data = NULL) { /** * Linked resource name. * - * Generated from protobuf field string linked_resource = 8; + * Generated from protobuf field string linked_resource = 8 [deprecated = true]; * @return string + * @deprecated */ public function getLinkedResource() { + @trigger_error('linked_resource is deprecated.', E_USER_DEPRECATED); return $this->linked_resource; } /** * Linked resource name. * - * Generated from protobuf field string linked_resource = 8; + * Generated from protobuf field string linked_resource = 8 [deprecated = true]; * @param string $var * @return $this + * @deprecated */ public function setLinkedResource($var) { + @trigger_error('linked_resource is deprecated.', E_USER_DEPRECATED); GPBUtil::checkString($var, True); $this->linked_resource = $var; @@ -80,8 +83,6 @@ public function setLinkedResource($var) } /** - * Entry format of the result. - * * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 9; * @return \Google\Cloud\Dataplex\V1\Entry|null */ @@ -101,8 +102,6 @@ public function clearDataplexEntry() } /** - * Entry format of the result. - * * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 9; * @param \Google\Cloud\Dataplex\V1\Entry $var * @return $this @@ -118,33 +117,39 @@ public function setDataplexEntry($var) /** * Snippets. * - * Generated from protobuf field .google.cloud.dataplex.v1.SearchEntriesResult.Snippets snippets = 12; + * Generated from protobuf field .google.cloud.dataplex.v1.SearchEntriesResult.Snippets snippets = 12 [deprecated = true]; * @return \Google\Cloud\Dataplex\V1\SearchEntriesResult\Snippets|null + * @deprecated */ public function getSnippets() { + @trigger_error('snippets is deprecated.', E_USER_DEPRECATED); return $this->snippets; } public function hasSnippets() { + @trigger_error('snippets is deprecated.', E_USER_DEPRECATED); return isset($this->snippets); } public function clearSnippets() { + @trigger_error('snippets is deprecated.', E_USER_DEPRECATED); unset($this->snippets); } /** * Snippets. * - * Generated from protobuf field .google.cloud.dataplex.v1.SearchEntriesResult.Snippets snippets = 12; + * Generated from protobuf field .google.cloud.dataplex.v1.SearchEntriesResult.Snippets snippets = 12 [deprecated = true]; * @param \Google\Cloud\Dataplex\V1\SearchEntriesResult\Snippets $var * @return $this + * @deprecated */ public function setSnippets($var) { + @trigger_error('snippets is deprecated.', E_USER_DEPRECATED); GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\SearchEntriesResult\Snippets::class); $this->snippets = $var; diff --git a/Dataplex/src/V1/SearchEntriesResult/Snippets.php b/Dataplex/src/V1/SearchEntriesResult/Snippets.php index ead8618f3fa1..097607b3ead9 100644 --- a/Dataplex/src/V1/SearchEntriesResult/Snippets.php +++ b/Dataplex/src/V1/SearchEntriesResult/Snippets.php @@ -12,6 +12,7 @@ * Snippets for the entry, contains HTML-style highlighting for * matched tokens, will be used in UI. * + * @deprecated * Generated from protobuf message google.cloud.dataplex.v1.SearchEntriesResult.Snippets */ class Snippets extends \Google\Protobuf\Internal\Message @@ -19,7 +20,8 @@ class Snippets extends \Google\Protobuf\Internal\Message /** * Entry * - * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 1; + * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 1 [deprecated = true]; + * @deprecated */ protected $dataplex_entry = null; @@ -41,33 +43,39 @@ public function __construct($data = NULL) { /** * Entry * - * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 1; + * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 1 [deprecated = true]; * @return \Google\Cloud\Dataplex\V1\Entry|null + * @deprecated */ public function getDataplexEntry() { + @trigger_error('dataplex_entry is deprecated.', E_USER_DEPRECATED); return $this->dataplex_entry; } public function hasDataplexEntry() { + @trigger_error('dataplex_entry is deprecated.', E_USER_DEPRECATED); return isset($this->dataplex_entry); } public function clearDataplexEntry() { + @trigger_error('dataplex_entry is deprecated.', E_USER_DEPRECATED); unset($this->dataplex_entry); } /** * Entry * - * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 1; + * Generated from protobuf field .google.cloud.dataplex.v1.Entry dataplex_entry = 1 [deprecated = true]; * @param \Google\Cloud\Dataplex\V1\Entry $var * @return $this + * @deprecated */ public function setDataplexEntry($var) { + @trigger_error('dataplex_entry is deprecated.', E_USER_DEPRECATED); GPBUtil::checkMessage($var, \Google\Cloud\Dataplex\V1\Entry::class); $this->dataplex_entry = $var;