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
googleapis · Nov 16, 2023 · 404a852 · 404a852
1 parent edca339
commit 404a852
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 1 deletion.
diff --git 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/...oogle-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResult.java b/...oogle-cloud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResult.java
@@ -2020,6 +2020,9 @@ public boolean getPassed() {
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2034,6 +2037,9 @@ public boolean getPassed() {
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2048,6 +2054,9 @@ public boolean getPassed() {
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2061,6 +2070,9 @@ public int getDimensionsCount() {
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2074,6 +2086,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult getDimensions(int
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2927,6 +2942,9 @@ private void ensureDimensionsIsMutable() {
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2944,6 +2962,9 @@ private void ensureDimensionsIsMutable() {
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2960,6 +2981,9 @@ public int getDimensionsCount() {
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2976,6 +3000,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult getDimensions(int
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -2999,6 +3026,9 @@ public Builder setDimensions(
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3020,6 +3050,9 @@ public Builder setDimensions(
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3042,6 +3075,9 @@ public Builder addDimensions(com.google.cloud.dataplex.v1.DataQualityDimensionRe
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3065,6 +3101,9 @@ public Builder addDimensions(
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3085,6 +3124,9 @@ public Builder addDimensions(
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3106,6 +3148,9 @@ public Builder addDimensions(
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3127,6 +3172,9 @@ public Builder addAllDimensions(
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3146,6 +3194,9 @@ public Builder clearDimensions() {
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3165,6 +3216,9 @@ public Builder removeDimensions(int index) {
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3178,6 +3232,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult.Builder getDimens
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3195,6 +3252,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResultOrBuilder getDimen
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3213,6 +3273,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResultOrBuilder getDimen
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3226,6 +3289,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult.Builder addDimens
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -3241,6 +3307,9 @@ public com.google.cloud.dataplex.v1.DataQualityDimensionResult.Builder addDimens
      *
      * <pre>
      * 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.
      * </pre>
      *
      * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>

diff --git a/...ud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResultOrBuilder.java b/...ud-dataplex-v1/src/main/java/com/google/cloud/dataplex/v1/DataQualityResultOrBuilder.java
@@ -41,6 +41,9 @@ public interface DataQualityResultOrBuilder
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -51,6 +54,9 @@ public interface DataQualityResultOrBuilder
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -61,6 +67,9 @@ public interface DataQualityResultOrBuilder
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -71,6 +80,9 @@ public interface DataQualityResultOrBuilder
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>
@@ -82,6 +94,9 @@ public interface DataQualityResultOrBuilder
    *
    * <pre>
    * 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.
    * </pre>
    *
    * <code>repeated .google.cloud.dataplex.v1.DataQualityDimensionResult dimensions = 2;</code>

diff --git a/...proto-google-cloud-dataplex-v1/src/main/proto/google/cloud/dataplex/v1/data_quality.proto b/...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.