@maxim_mazurok/gapi.client.dataplex-v1 0.0.20230607 → 0.0.20230616

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://dataplex.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230607
+// Revision: 20230616
 
 /// <reference types="gapi.client" />
 
@@ -515,8 +515,8 @@ declare namespace gapi.client {
             stringProfile?:
                 GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo;
             /**
-             * The list of top N non-null values and number of times they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not
-             * available for complex non-groupable field type RECORD and fields with REPEATABLE mode.
+             * The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is
+             * smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.
              */
             topNValues?:
                 GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue[];
@@ -580,6 +580,9 @@ declare namespace gapi.client {
             /** Count of the corresponding value in the scanned data. */
             count?:
                 string;
+            /** Ratio of the corresponding value in the field against the total number of rows in the scanned data. */
+            ratio?:
+                number;
             /** String value of a top N non-null value. */
             value?:
                 string;
@@ -638,6 +641,9 @@ declare namespace gapi.client {
             /** Optional. The unnested column which this rule is evaluated against. */
             column?:
                 string;
+            /** Optional. Description of the rule. The maximum length is 1,024 characters. */
+            description?:
+                string;
             /**
              * Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY",
              * "UNIQUENESS", "INTEGRITY"
@@ -645,36 +651,45 @@ declare namespace gapi.client {
             dimension?:
                 string;
             /**
-             * Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.Only applicable to
-             * ColumnMap rules.
+             * Optional. Rows with null values will automatically fail a rule, unless ignore_null is true. In that case, such null rows are trivially considered passing.This field is only valid
+             * for row-level type rules.
              */
             ignoreNull?:
                 boolean;
-            /** ColumnMap rule which evaluates whether each column value is null. */
+            /**
+             * Optional. A mutable name for the rule. The name must contain only letters (a-z, A-Z), numbers (0-9), or hyphens (-). The maximum length is 63 characters. Must start with a letter.
+             * Must end with a number or a letter.
+             */
+            name?:
+                string;
+            /** Row-level rule which evaluates whether each column value is null. */
             nonNullExpectation?:
                 any;
-            /** ColumnMap rule which evaluates whether each column value lies between a specified range. */
+            /** Row-level rule which evaluates whether each column value lies between a specified range. */
             rangeExpectation?:
                 GoogleCloudDataplexV1DataQualityRuleRangeExpectation;
-            /** ColumnMap rule which evaluates whether each column value matches a specified regex. */
+            /** Row-level rule which evaluates whether each column value matches a specified regex. */
             regexExpectation?:
                 GoogleCloudDataplexV1DataQualityRuleRegexExpectation;
-            /** Table rule which evaluates whether each row passes the specified condition. */
+            /** Row-level rule which evaluates whether each row in a table passes the specified condition. */
             rowConditionExpectation?:
                 GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation;
-            /** ColumnMap rule which evaluates whether each column value is contained by a specified set. */
+            /** Row-level rule which evaluates whether each column value is contained by a specified set. */
             setExpectation?:
                 GoogleCloudDataplexV1DataQualityRuleSetExpectation;
-            /** ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range. */
+            /** Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range. */
             statisticRangeExpectation?:
                 GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation;
-            /** Table rule which evaluates whether the provided expression is true. */
+            /** Aggregate rule which evaluates whether the provided expression is true for a table. */
             tableConditionExpectation?:
                 GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation;
-            /** Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0). */
+            /**
+             * Optional. The minimum ratio of passing_rows / total_rows required to pass this rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).This field is only valid for
+             * row-level type rules.
+             */
             threshold?:
                 number;
-            /** ColumnAggregate rule which evaluates whether the column has duplicates. */
+            /** Aggregate rule which evaluates whether the column has duplicates. */
             uniquenessExpectation?:
                 any;
         }
@@ -702,12 +717,12 @@ declare namespace gapi.client {
         }
         interface GoogleCloudDataplexV1DataQualityRuleResult {
             /**
-             * The number of rows a rule was evaluated against. This field is only valid for ColumnMap type rules.Evaluated count can be configured to either include all rows (default) - with null
+             * The number of rows a rule was evaluated against.This field is only valid for row-level type rules.Evaluated count can be configured to either include all rows (default) - with null
              * rows automatically failing rule evaluation, or exclude null rows from the evaluated_count, by setting ignore_nulls = true.
              */
             evaluatedCount?:
                 string;
-            /** The query to find rows that did not pass this rule. Only applies to ColumnMap and RowCondition rules. */
+            /** The query to find rows that did not pass this rule.This field is only valid for row-level type rules. */
             failingRowsQuery?:
                 string;
             /** The number of rows with null values in the specified column. */
@@ -716,10 +731,10 @@ declare namespace gapi.client {
             /** Whether the rule passed or failed. */
             passed?:
                 boolean;
-            /** The number of rows which passed a rule evaluation. This field is only valid for ColumnMap type rules. */
+            /** The number of rows which passed a rule evaluation.This field is only valid for row-level type rules. */
             passedCount?:
                 string;
-            /** The ratio of passed_count / evaluated_count. This field is only valid for ColumnMap type rules. */
+            /** The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. */
             passRatio?:
                 number;
             /** The rule specified in the DataQualitySpec, as is. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.dataplex-v1",
-  "version": "0.0.20230607",
+  "version": "0.0.20230616",
   "description": "TypeScript typings for Cloud Dataplex API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230607
+// Revision: 20230616
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -267,6 +267,7 @@ gapi.load('client', async () => {
                                 topNValues: [
                                     {
                                         count: "Test string",
+                                        ratio: 42,
                                         value: "Test string",
                                     }
                                 ],
@@ -316,8 +317,10 @@ gapi.load('client', async () => {
                         passRatio: 42,
                         rule: {
                             column: "Test string",
+                            description: "Test string",
                             dimension: "Test string",
                             ignoreNull: true,
+                            name: "Test string",
                             nonNullExpectation: {
                             },
                             rangeExpectation: {
@@ -366,8 +369,10 @@ gapi.load('client', async () => {
                 rules: [
                     {
                         column: "Test string",
+                        description: "Test string",
                         dimension: "Test string",
                         ignoreNull: true,
+                        name: "Test string",
                         nonNullExpectation: {
                         },
                         rangeExpectation: {
@@ -497,6 +502,7 @@ gapi.load('client', async () => {
                                 topNValues: [
                                     {
                                         count: "Test string",
+                                        ratio: 42,
                                         value: "Test string",
                                     }
                                 ],
@@ -546,8 +552,10 @@ gapi.load('client', async () => {
                         passRatio: 42,
                         rule: {
                             column: "Test string",
+                            description: "Test string",
                             dimension: "Test string",
                             ignoreNull: true,
+                            name: "Test string",
                             nonNullExpectation: {
                             },
                             rangeExpectation: {
@@ -596,8 +604,10 @@ gapi.load('client', async () => {
                 rules: [
                     {
                         column: "Test string",
+                        description: "Test string",
                         dimension: "Test string",
                         ignoreNull: true,
+                        name: "Test string",
                         nonNullExpectation: {
                         },
                         rangeExpectation: {