feat(dataplex): update the api

#### dataplex:v1 The following keys were added: - resources.projects.resources.locations.methods.lookupEntry (Total Keys: 21) - resources.projects.resources.locations.methods.searchEntries (Total Keys: 22) - resources.projects.resources.locations.resources.aspectTypes.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.aspectTypes.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.aspectTypes.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.aspectTypes.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.aspectTypes.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.dataScans.methods.generateDataQualityRules (Total Keys: 12) - resources.projects.resources.locations.resources.dataScans.resources.jobs.methods.generateDataQualityRules (Total Keys: 12) - resources.projects.resources.locations.resources.entryGroups.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.entryGroups.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.entryGroups.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.entryGroups.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.entryGroups.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.get (Total Keys: 19) - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.entryGroups.resources.entries.methods.patch (Total Keys: 22) - resources.projects.resources.locations.resources.entryTypes.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.entryTypes.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.entryTypes.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.entryTypes.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.entryTypes.methods.patch (Total Keys: 17) - schemas.GoogleCloudDataplexV1Aspect (Total Keys: 69) - schemas.GoogleCloudDataplexV1Entry (Total Keys: 78) - schemas.GoogleCloudDataplexV1GenerateDataQualityRulesRequest (Total Keys: 2) - schemas.GoogleCloudDataplexV1GenerateDataQualityRulesResponse (Total Keys: 4) - schemas.GoogleCloudDataplexV1ListAspectTypesResponse (Total Keys: 7) - schemas.GoogleCloudDataplexV1ListEntriesResponse (Total Keys: 5) - schemas.GoogleCloudDataplexV1ListEntryGroupsResponse (Total Keys: 7) - schemas.GoogleCloudDataplexV1ListEntryTypesResponse (Total Keys: 7) - schemas.GoogleCloudDataplexV1SearchEntriesResponse (Total Keys: 9) - schemas.GoogleCloudDataplexV1SearchEntriesResult (Total Keys: 21)
googleapis · Mar 19, 2024 · 59be5b7 · 59be5b7
1 parent 2e6f805
commit 59be5b7
Show file tree

Hide file tree

Showing 8 changed files with 3,680 additions and 102 deletions.
diff --git a/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html b/docs/dyn/dataplex_v1.projects.locations.aspectTypes.html
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
@@ -88,6 +88,9 @@ <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Deletes a DataScan resource.</p>
+<p class="toc_element">
+  <code><a href="#generateDataQualityRules">generateDataQualityRules(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Generates recommended DataQualityRule from a data profiling DataScan.</p>
 <p class="toc_element">
   <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets a DataScan resource.</p>
@@ -133,6 +136,16 @@ <h3>Method Details</h3>
     &quot;entity&quot;: &quot;A String&quot;, # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
     &quot;resource&quot;: &quot;A String&quot;, # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type &quot;TABLE&quot; for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
   },
+  &quot;dataDocumentationResult&quot;: { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan.
+    &quot;queries&quot;: [ # Output only. The list of generated queries.
+      { # A query in data documentation
+        &quot;description&quot;: &quot;A String&quot;, # Output only. The description for the query.
+        &quot;sql&quot;: &quot;A String&quot;, # Output only. The SQL query string which can be executed.
+      },
+    ],
+  },
+  &quot;dataDocumentationSpec&quot;: { # DataDocumentation scan related spec. # DataDocumentationScan related setting.
+  },
   &quot;dataProfileResult&quot;: { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
     &quot;postScanActionsResult&quot;: { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
       &quot;bigqueryExportResult&quot;: { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -449,6 +462,71 @@ <h3>Method Details</h3>
 }</pre>
 </div>
 
+<div class="method">
+    <code class="details" id="generateDataQualityRules">generateDataQualityRules(name, body=None, x__xgafv=None)</code>
+  <pre>Generates recommended DataQualityRule from a data profiling DataScan.
+
+Args:
+  name: string, 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)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Generate recommended DataQualityRules request.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Generate recommended DataQualityRules response.
+  &quot;rule&quot;: [ # Generated recommended {@link DataQualityRule}s.
+    { # A rule captures data quality intent about a data source.
+      &quot;column&quot;: &quot;A String&quot;, # Optional. The unnested column which this rule is evaluated against.
+      &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the rule. The maximum length is 1,024 characters.
+      &quot;dimension&quot;: &quot;A String&quot;, # Required. The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are &quot;COMPLETENESS&quot;, &quot;ACCURACY&quot;, &quot;CONSISTENCY&quot;, &quot;VALIDITY&quot;, &quot;UNIQUENESS&quot;, &quot;INTEGRITY&quot;
+      &quot;ignoreNull&quot;: True or False, # 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 the following type of rules: RangeExpectation RegexExpectation SetExpectation UniquenessExpectation
+      &quot;name&quot;: &quot;A String&quot;, # 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.
+      &quot;nonNullExpectation&quot;: { # Evaluates whether each column value is null. # Row-level rule which evaluates whether each column value is null.
+      },
+      &quot;rangeExpectation&quot;: { # Evaluates whether each column value lies between a specified range. # Row-level rule which evaluates whether each column value lies between a specified range.
+        &quot;maxValue&quot;: &quot;A String&quot;, # Optional. The maximum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+        &quot;minValue&quot;: &quot;A String&quot;, # Optional. The minimum column value allowed for a row to pass this validation. At least one of min_value and max_value need to be provided.
+        &quot;strictMaxEnabled&quot;: True or False, # Optional. Whether each value needs to be strictly lesser than (&#x27;&lt;&#x27;) the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.
+        &quot;strictMinEnabled&quot;: True or False, # Optional. Whether each value needs to be strictly greater than (&#x27;&gt;&#x27;) the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.
+      },
+      &quot;regexExpectation&quot;: { # Evaluates whether each column value matches a specified regex. # Row-level rule which evaluates whether each column value matches a specified regex.
+        &quot;regex&quot;: &quot;A String&quot;, # Optional. A regular expression the column value is expected to match.
+      },
+      &quot;rowConditionExpectation&quot;: { # Evaluates whether each row passes the specified condition.The SQL expression needs to use BigQuery standard SQL syntax and should produce a boolean value per row as the result.Example: col1 &gt;= 0 AND col2 &lt; 10 # Row-level rule which evaluates whether each row in a table passes the specified condition.
+        &quot;sqlExpression&quot;: &quot;A String&quot;, # Optional. The SQL expression.
+      },
+      &quot;setExpectation&quot;: { # 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.
+        &quot;values&quot;: [ # Optional. Expected values for the column value.
+          &quot;A String&quot;,
+        ],
+      },
+      &quot;statisticRangeExpectation&quot;: { # 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.
+        &quot;maxValue&quot;: &quot;A String&quot;, # Optional. The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.
+        &quot;minValue&quot;: &quot;A String&quot;, # Optional. The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided.
+        &quot;statistic&quot;: &quot;A String&quot;, # Optional. The aggregate metric to evaluate.
+        &quot;strictMaxEnabled&quot;: True or False, # Optional. Whether column statistic needs to be strictly lesser than (&#x27;&lt;&#x27;) the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false.
+        &quot;strictMinEnabled&quot;: True or False, # Optional. Whether column statistic needs to be strictly greater than (&#x27;&gt;&#x27;) the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false.
+      },
+      &quot;tableConditionExpectation&quot;: { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) &gt;= 0 # Aggregate rule which evaluates whether the provided expression is true for a table.
+        &quot;sqlExpression&quot;: &quot;A String&quot;, # Optional. The SQL expression.
+      },
+      &quot;threshold&quot;: 3.14, # 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.
+      &quot;uniquenessExpectation&quot;: { # Evaluates whether the column has duplicates. # Row-level rule which evaluates whether each column value is unique.
+      },
+    },
+  ],
+}</pre>
+</div>
+
 <div class="method">
     <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
   <pre>Gets a DataScan resource.
@@ -474,6 +552,16 @@ <h3>Method Details</h3>
     &quot;entity&quot;: &quot;A String&quot;, # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
     &quot;resource&quot;: &quot;A String&quot;, # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type &quot;TABLE&quot; for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
   },
+  &quot;dataDocumentationResult&quot;: { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan.
+    &quot;queries&quot;: [ # Output only. The list of generated queries.
+      { # A query in data documentation
+        &quot;description&quot;: &quot;A String&quot;, # Output only. The description for the query.
+        &quot;sql&quot;: &quot;A String&quot;, # Output only. The SQL query string which can be executed.
+      },
+    ],
+  },
+  &quot;dataDocumentationSpec&quot;: { # DataDocumentation scan related spec. # DataDocumentationScan related setting.
+  },
   &quot;dataProfileResult&quot;: { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
     &quot;postScanActionsResult&quot;: { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
       &quot;bigqueryExportResult&quot;: { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -799,6 +887,16 @@ <h3>Method Details</h3>
         &quot;entity&quot;: &quot;A String&quot;, # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
         &quot;resource&quot;: &quot;A String&quot;, # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type &quot;TABLE&quot; for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
       },
+      &quot;dataDocumentationResult&quot;: { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan.
+        &quot;queries&quot;: [ # Output only. The list of generated queries.
+          { # A query in data documentation
+            &quot;description&quot;: &quot;A String&quot;, # Output only. The description for the query.
+            &quot;sql&quot;: &quot;A String&quot;, # Output only. The SQL query string which can be executed.
+          },
+        ],
+      },
+      &quot;dataDocumentationSpec&quot;: { # DataDocumentation scan related spec. # DataDocumentationScan related setting.
+      },
       &quot;dataProfileResult&quot;: { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
         &quot;postScanActionsResult&quot;: { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
           &quot;bigqueryExportResult&quot;: { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -1085,6 +1183,16 @@ <h3>Method Details</h3>
     &quot;entity&quot;: &quot;A String&quot;, # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery table) for DataScan, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
     &quot;resource&quot;: &quot;A String&quot;, # Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could be: BigQuery table of type &quot;TABLE&quot; for DataProfileScan/DataQualityScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
   },
+  &quot;dataDocumentationResult&quot;: { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan.
+    &quot;queries&quot;: [ # Output only. The list of generated queries.
+      { # A query in data documentation
+        &quot;description&quot;: &quot;A String&quot;, # Output only. The description for the query.
+        &quot;sql&quot;: &quot;A String&quot;, # Output only. The SQL query string which can be executed.
+      },
+    ],
+  },
+  &quot;dataDocumentationSpec&quot;: { # DataDocumentation scan related spec. # DataDocumentationScan related setting.
+  },
   &quot;dataProfileResult&quot;: { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
     &quot;postScanActionsResult&quot;: { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
       &quot;bigqueryExportResult&quot;: { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.
@@ -1388,6 +1496,16 @@ <h3>Method Details</h3>
 
     { # Run DataScan Response.
   &quot;job&quot;: { # A DataScanJob represents an instance of DataScan execution. # DataScanJob created by RunDataScan request.
+    &quot;dataDocumentationResult&quot;: { # The output of a DataDocumentation scan. # Output only. The result of the data documentation scan.
+      &quot;queries&quot;: [ # Output only. The list of generated queries.
+        { # A query in data documentation
+          &quot;description&quot;: &quot;A String&quot;, # Output only. The description for the query.
+          &quot;sql&quot;: &quot;A String&quot;, # Output only. The SQL query string which can be executed.
+        },
+      ],
+    },
+    &quot;dataDocumentationSpec&quot;: { # DataDocumentation scan related spec. # Output only. DataDocumentationScan related setting.
+    },
     &quot;dataProfileResult&quot;: { # DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. # Output only. The result of the data profile scan.
       &quot;postScanActionsResult&quot;: { # The result of post scan actions of DataProfileScan job. # Output only. The result of post scan actions.
         &quot;bigqueryExportResult&quot;: { # The result of BigQuery export post scan action. # Output only. The result of BigQuery export post scan action.