Skip to content

Commit

Permalink
feat(dataplex): update the api
Browse files Browse the repository at this point in the history
#### dataplex:v1

The following keys were added:
- schemas.GoogleCloudDataplexV1DataQualityColumnResult (Total Keys: 7)
- schemas.GoogleCloudDataplexV1DataQualityDimensionResult.properties.score (Total Keys: 3)
- schemas.GoogleCloudDataplexV1DataQualityResult.properties.columns (Total Keys: 3)
- schemas.GoogleCloudDataplexV1DataQualityResult.properties.score (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Dec 7, 2023
1 parent 3064343 commit 5ae3e13
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 3 deletions.
40 changes: 40 additions & 0 deletions docs/dyn/dataplex_v1.projects.locations.dataScans.html
Expand Up @@ -212,12 +212,19 @@ <h3>Method Details</h3>
&quot;samplingPercent&quot;: 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
},
&quot;dataQualityResult&quot;: { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
&quot;columns&quot;: [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the &#x27;column&#x27; field set to it.
{ # DataQualityColumnResult provides a more detailed, per-column view of the results.
&quot;column&quot;: &quot;A String&quot;, # Output only. The column specified in the DataQualityRule.
&quot;score&quot;: 3.14, # Output only. The column-level data quality score for this data scan job if and only if the &#x27;column&#x27; field is set.The score ranges between between 0, 100 (up to two decimal points).
},
],
&quot;dimensions&quot;: [ # 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 &#x27;dimension&#x27; field set to it.
{ # DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
&quot;dimension&quot;: { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is.
&quot;name&quot;: &quot;A String&quot;, # The dimension name a rule belongs to. Supported dimensions are &quot;COMPLETENESS&quot;, &quot;ACCURACY&quot;, &quot;CONSISTENCY&quot;, &quot;VALIDITY&quot;, &quot;UNIQUENESS&quot;, &quot;INTEGRITY&quot;
},
&quot;passed&quot;: True or False, # Whether the dimension passed or failed.
&quot;score&quot;: 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the &#x27;dimension&#x27; field is set.The score ranges between 0, 100 (up to two decimal points).
},
],
&quot;passed&quot;: True or False, # Overall data quality result -- true if all rules passed.
Expand Down Expand Up @@ -284,6 +291,7 @@ <h3>Method Details</h3>
&quot;start&quot;: &quot;A String&quot;, # Value that marks the start of the range.
},
},
&quot;score&quot;: 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).
},
&quot;dataQualitySpec&quot;: { # DataQualityScan related setting. # DataQualityScan related setting.
&quot;postScanActions&quot;: { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion.
Expand Down Expand Up @@ -531,12 +539,19 @@ <h3>Method Details</h3>
&quot;samplingPercent&quot;: 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
},
&quot;dataQualityResult&quot;: { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
&quot;columns&quot;: [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the &#x27;column&#x27; field set to it.
{ # DataQualityColumnResult provides a more detailed, per-column view of the results.
&quot;column&quot;: &quot;A String&quot;, # Output only. The column specified in the DataQualityRule.
&quot;score&quot;: 3.14, # Output only. The column-level data quality score for this data scan job if and only if the &#x27;column&#x27; field is set.The score ranges between between 0, 100 (up to two decimal points).
},
],
&quot;dimensions&quot;: [ # 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 &#x27;dimension&#x27; field set to it.
{ # DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
&quot;dimension&quot;: { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is.
&quot;name&quot;: &quot;A String&quot;, # The dimension name a rule belongs to. Supported dimensions are &quot;COMPLETENESS&quot;, &quot;ACCURACY&quot;, &quot;CONSISTENCY&quot;, &quot;VALIDITY&quot;, &quot;UNIQUENESS&quot;, &quot;INTEGRITY&quot;
},
&quot;passed&quot;: True or False, # Whether the dimension passed or failed.
&quot;score&quot;: 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the &#x27;dimension&#x27; field is set.The score ranges between 0, 100 (up to two decimal points).
},
],
&quot;passed&quot;: True or False, # Overall data quality result -- true if all rules passed.
Expand Down Expand Up @@ -603,6 +618,7 @@ <h3>Method Details</h3>
&quot;start&quot;: &quot;A String&quot;, # Value that marks the start of the range.
},
},
&quot;score&quot;: 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).
},
&quot;dataQualitySpec&quot;: { # DataQualityScan related setting. # DataQualityScan related setting.
&quot;postScanActions&quot;: { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion.
Expand Down Expand Up @@ -834,12 +850,19 @@ <h3>Method Details</h3>
&quot;samplingPercent&quot;: 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
},
&quot;dataQualityResult&quot;: { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
&quot;columns&quot;: [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the &#x27;column&#x27; field set to it.
{ # DataQualityColumnResult provides a more detailed, per-column view of the results.
&quot;column&quot;: &quot;A String&quot;, # Output only. The column specified in the DataQualityRule.
&quot;score&quot;: 3.14, # Output only. The column-level data quality score for this data scan job if and only if the &#x27;column&#x27; field is set.The score ranges between between 0, 100 (up to two decimal points).
},
],
&quot;dimensions&quot;: [ # 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 &#x27;dimension&#x27; field set to it.
{ # DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
&quot;dimension&quot;: { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is.
&quot;name&quot;: &quot;A String&quot;, # The dimension name a rule belongs to. Supported dimensions are &quot;COMPLETENESS&quot;, &quot;ACCURACY&quot;, &quot;CONSISTENCY&quot;, &quot;VALIDITY&quot;, &quot;UNIQUENESS&quot;, &quot;INTEGRITY&quot;
},
&quot;passed&quot;: True or False, # Whether the dimension passed or failed.
&quot;score&quot;: 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the &#x27;dimension&#x27; field is set.The score ranges between 0, 100 (up to two decimal points).
},
],
&quot;passed&quot;: True or False, # Overall data quality result -- true if all rules passed.
Expand Down Expand Up @@ -906,6 +929,7 @@ <h3>Method Details</h3>
&quot;start&quot;: &quot;A String&quot;, # Value that marks the start of the range.
},
},
&quot;score&quot;: 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).
},
&quot;dataQualitySpec&quot;: { # DataQualityScan related setting. # DataQualityScan related setting.
&quot;postScanActions&quot;: { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion.
Expand Down Expand Up @@ -1098,12 +1122,19 @@ <h3>Method Details</h3>
&quot;samplingPercent&quot;: 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
},
&quot;dataQualityResult&quot;: { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
&quot;columns&quot;: [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the &#x27;column&#x27; field set to it.
{ # DataQualityColumnResult provides a more detailed, per-column view of the results.
&quot;column&quot;: &quot;A String&quot;, # Output only. The column specified in the DataQualityRule.
&quot;score&quot;: 3.14, # Output only. The column-level data quality score for this data scan job if and only if the &#x27;column&#x27; field is set.The score ranges between between 0, 100 (up to two decimal points).
},
],
&quot;dimensions&quot;: [ # 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 &#x27;dimension&#x27; field set to it.
{ # DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
&quot;dimension&quot;: { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is.
&quot;name&quot;: &quot;A String&quot;, # The dimension name a rule belongs to. Supported dimensions are &quot;COMPLETENESS&quot;, &quot;ACCURACY&quot;, &quot;CONSISTENCY&quot;, &quot;VALIDITY&quot;, &quot;UNIQUENESS&quot;, &quot;INTEGRITY&quot;
},
&quot;passed&quot;: True or False, # Whether the dimension passed or failed.
&quot;score&quot;: 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the &#x27;dimension&#x27; field is set.The score ranges between 0, 100 (up to two decimal points).
},
],
&quot;passed&quot;: True or False, # Overall data quality result -- true if all rules passed.
Expand Down Expand Up @@ -1170,6 +1201,7 @@ <h3>Method Details</h3>
&quot;start&quot;: &quot;A String&quot;, # Value that marks the start of the range.
},
},
&quot;score&quot;: 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).
},
&quot;dataQualitySpec&quot;: { # DataQualityScan related setting. # DataQualityScan related setting.
&quot;postScanActions&quot;: { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion.
Expand Down Expand Up @@ -1379,12 +1411,19 @@ <h3>Method Details</h3>
&quot;samplingPercent&quot;: 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
},
&quot;dataQualityResult&quot;: { # The output of a DataQualityScan. # Output only. The result of the data quality scan.
&quot;columns&quot;: [ # Output only. A list of results at the column level.A column will have a corresponding DataQualityColumnResult if and only if there is at least one rule with the &#x27;column&#x27; field set to it.
{ # DataQualityColumnResult provides a more detailed, per-column view of the results.
&quot;column&quot;: &quot;A String&quot;, # Output only. The column specified in the DataQualityRule.
&quot;score&quot;: 3.14, # Output only. The column-level data quality score for this data scan job if and only if the &#x27;column&#x27; field is set.The score ranges between between 0, 100 (up to two decimal points).
},
],
&quot;dimensions&quot;: [ # 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 &#x27;dimension&#x27; field set to it.
{ # DataQualityDimensionResult provides a more detailed, per-dimension view of the results.
&quot;dimension&quot;: { # A dimension captures data quality intent about a defined subset of the rules specified. # Output only. The dimension config specified in the DataQualitySpec, as is.
&quot;name&quot;: &quot;A String&quot;, # The dimension name a rule belongs to. Supported dimensions are &quot;COMPLETENESS&quot;, &quot;ACCURACY&quot;, &quot;CONSISTENCY&quot;, &quot;VALIDITY&quot;, &quot;UNIQUENESS&quot;, &quot;INTEGRITY&quot;
},
&quot;passed&quot;: True or False, # Whether the dimension passed or failed.
&quot;score&quot;: 3.14, # Output only. The dimension-level data quality score for this data scan job if and only if the &#x27;dimension&#x27; field is set.The score ranges between 0, 100 (up to two decimal points).
},
],
&quot;passed&quot;: True or False, # Overall data quality result -- true if all rules passed.
Expand Down Expand Up @@ -1451,6 +1490,7 @@ <h3>Method Details</h3>
&quot;start&quot;: &quot;A String&quot;, # Value that marks the start of the range.
},
},
&quot;score&quot;: 3.14, # Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points).
},
&quot;dataQualitySpec&quot;: { # DataQualityScan related setting. # Output only. DataQualityScan related setting.
&quot;postScanActions&quot;: { # The configuration of post scan actions of DataQualityScan. # Optional. Actions to take upon job completion.
Expand Down

0 comments on commit 5ae3e13

Please sign in to comment.