From 404a85295344cf2e8b3fe13d9f595279847630fa Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Thu, 16 Nov 2023 19:02:32 +0000 Subject: [PATCH] docs: [dataplex] updated comments for `DataQualityResult.dimensions` field (#10044) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 579907849 Source-Link: https://togithub.com/googleapis/googleapis/commit/418208c1d1442d978a8b24b43338adcedcaa8305 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/67528c1f0e388b165ecac910ac56fe687c43290f Copy-Tag: eyJwIjoiamF2YS1kYXRhcGxleC8uT3dsQm90LnlhbWwiLCJoIjoiNjc1MjhjMWYwZTM4OGIxNjVlY2FjOTEwYWM1NmZlNjg3YzQzMjkwZiJ9 --- java-dataplex/README.md | 2 +- .../cloud/dataplex/v1/DataQualityResult.java | 69 +++++++++++++++++++ .../v1/DataQualityResultOrBuilder.java | 15 ++++ .../cloud/dataplex/v1/data_quality.proto | 3 + 4 files changed, 88 insertions(+), 1 deletion(-) diff --git a/java-dataplex/README.md b/java-dataplex/README.md index 6a101dce8bf1..266ac5264ff7 100644 --- a/java-dataplex/README.md +++ b/java-dataplex/README.md @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates. [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html [stability-image]: https://img.shields.io/badge/stability-stable-green [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-dataplex.svg -[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-dataplex/1.27.0 +[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-dataplex/1.28.0 [authentication]: https://github.com/googleapis/google-cloud-java#authentication [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles diff --git a/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResult.java b/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResult.java index e7cbdfdfe68e..279f78986cf5 100644 --- a/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResult.java +++ b/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResult.java @@ -2020,6 +2020,9 @@ public boolean getPassed() { * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2034,6 +2037,9 @@ public boolean getPassed() { * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2048,6 +2054,9 @@ public boolean getPassed() { * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2061,6 +2070,9 @@ public int getDimensionsCount() { * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2074,6 +2086,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult getDimensions(int * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2927,6 +2942,9 @@ private void ensureDimensionsIsMutable() { * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2944,6 +2962,9 @@ private void ensureDimensionsIsMutable() { * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2960,6 +2981,9 @@ public int getDimensionsCount() { * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2976,6 +3000,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult getDimensions(int * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -2999,6 +3026,9 @@ public Builder setDimensions( * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3020,6 +3050,9 @@ public Builder setDimensions( * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3042,6 +3075,9 @@ public Builder addDimensions(com.google.cloud.dataplex.v1.DataQualityDimensionRe * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3065,6 +3101,9 @@ public Builder addDimensions( * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3085,6 +3124,9 @@ public Builder addDimensions( * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3106,6 +3148,9 @@ public Builder addDimensions( * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3127,6 +3172,9 @@ public Builder addAllDimensions( * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3146,6 +3194,9 @@ public Builder clearDimensions() { * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3165,6 +3216,9 @@ public Builder removeDimensions(int index) { * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3178,6 +3232,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult.Builder getDimens * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3195,6 +3252,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResultOrBuilder getDimen * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3213,6 +3273,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResultOrBuilder getDimen * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3226,6 +3289,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult.Builder addDimens * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -3241,6 +3307,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult.Builder addDimens * * 
      * A list of results at the dimension level.
+     *
+     * A dimension will have a corresponding `DataQualityDimensionResult` if and
+     * only if there is at least one rule with the 'dimension' field set to it.
      *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; diff --git a/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResultOrBuilder.java b/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResultOrBuilder.java index 7fbfc20a0b2d..df95bd6a1765 100644 --- a/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResultOrBuilder.java +++ b/java-dataplex/proto-google-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResultOrBuilder.java @@ -41,6 +41,9 @@ public interface DataQualityResultOrBuilder * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -51,6 +54,9 @@ public interface DataQualityResultOrBuilder * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -61,6 +67,9 @@ public interface DataQualityResultOrBuilder * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -71,6 +80,9 @@ public interface DataQualityResultOrBuilder * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; @@ -82,6 +94,9 @@ public interface DataQualityResultOrBuilder * * 
    * A list of results at the dimension level.
+   *
+   * A dimension will have a corresponding `DataQualityDimensionResult` if and
+   * only if there is at least one rule with the 'dimension' field set to it.
    *
* * repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2; diff --git a/java-dataplex/proto-google-cloud-dataplex-v1/src/main/proto/google/cloud/dataplex/v1/data_quality.proto b/java-dataplex/proto-google-cloud-dataplex-v1/src/main/proto/google/cloud/dataplex/v1/data_quality.proto index 8f0eb1759f73..bc2d57403c77 100644 --- a/java-dataplex/proto-google-cloud-dataplex-v1/src/main/proto/google/cloud/dataplex/v1/data_quality.proto +++ b/java-dataplex/proto-google-cloud-dataplex-v1/src/main/proto/google/cloud/dataplex/v1/data_quality.proto @@ -108,6 +108,9 @@ message DataQualityResult { bool passed = 5; // A list of results at the dimension level. + // + // A dimension will have a corresponding `DataQualityDimensionResult` if and + // only if there is at least one rule with the 'dimension' field set to it. repeated DataQualityDimensionResult dimensions = 2; // A list of all the rules in a job, and their results.