Skip to content

Commit 7d05df3

Browse files
yoshi-automationleahecole
authored andcommitted
feat(dataplex): update the API
#### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1DataProfileResult.properties.profile.readOnly - schemas.GoogleCloudDataplexV1DataProfileResult.properties.rowCount.readOnly - schemas.GoogleCloudDataplexV1DataProfileResult.properties.scannedData.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfile.properties.fields.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.mode.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.name.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.profile.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.type.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo.properties.distinctRatio.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo.properties.nullRatio.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo.properties.topNValues.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.average.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.max.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.min.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.quartiles.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.standardDeviation.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.average.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.max.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.min.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.quartiles.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.standardDeviation.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo.properties.averageLength.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo.properties.maxLength.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo.properties.minLength.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue.properties.count.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue.properties.ratio.readOnly - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue.properties.value.readOnly - schemas.GoogleCloudDataplexV1DataQualityDimension.properties.name.readOnly - schemas.GoogleCloudDataplexV1ScannedDataIncrementalField.properties.end.readOnly - schemas.GoogleCloudDataplexV1ScannedDataIncrementalField.properties.field.readOnly - schemas.GoogleCloudDataplexV1ScannedDataIncrementalField.properties.start.readOnly The following keys were changed: - schemas.GoogleCloudDataplexV1DataProfileResult.properties.profile.description - schemas.GoogleCloudDataplexV1DataProfileResult.properties.rowCount.description - schemas.GoogleCloudDataplexV1DataProfileResult.properties.scannedData.description - schemas.GoogleCloudDataplexV1DataProfileResultProfile.properties.fields.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.mode.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.name.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.profile.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileField.properties.type.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo.properties.distinctRatio.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo.properties.nullRatio.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo.properties.topNValues.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.average.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.max.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.min.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.quartiles.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo.properties.standardDeviation.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.average.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.max.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.min.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.quartiles.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo.properties.standardDeviation.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo.properties.averageLength.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo.properties.maxLength.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo.properties.minLength.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue.properties.count.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue.properties.ratio.description - schemas.GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue.properties.value.description - schemas.GoogleCloudDataplexV1DataProfileSpec.properties.rowFilter.description - schemas.GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport.properties.resultsTable.description - schemas.GoogleCloudDataplexV1DataQualityDimension.properties.name.description - schemas.GoogleCloudDataplexV1ScannedDataIncrementalField.properties.end.description - schemas.GoogleCloudDataplexV1ScannedDataIncrementalField.properties.field.description - schemas.GoogleCloudDataplexV1ScannedDataIncrementalField.properties.start.description
1 parent 7b55b90 commit 7d05df3

File tree

2 files changed

+98
-67
lines changed

2 files changed

+98
-67
lines changed

discovery/dataplex-v1.json

Lines changed: 65 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7211,7 +7211,7 @@
72117211
}
72127212
}
72137213
},
7214-
"revision": "20250805",
7214+
"revision": "20250808",
72157215
"rootUrl": "https://dataplex.googleapis.com/",
72167216
"schemas": {
72177217
"Empty": {
@@ -8594,16 +8594,19 @@
85948594
},
85958595
"profile": {
85968596
"$ref": "GoogleCloudDataplexV1DataProfileResultProfile",
8597-
"description": "The profile information per field."
8597+
"description": "Output only. The profile information per field.",
8598+
"readOnly": true
85988599
},
85998600
"rowCount": {
8600-
"description": "The count of rows scanned.",
8601+
"description": "Output only. The count of rows scanned.",
86018602
"format": "int64",
8603+
"readOnly": true,
86028604
"type": "string"
86038605
},
86048606
"scannedData": {
86058607
"$ref": "GoogleCloudDataplexV1ScannedData",
8606-
"description": "The data scanned for this result."
8608+
"description": "Output only. The data scanned for this result.",
8609+
"readOnly": true
86078610
}
86088611
},
86098612
"type": "object"
@@ -8654,10 +8657,11 @@
86548657
"id": "GoogleCloudDataplexV1DataProfileResultProfile",
86558658
"properties": {
86568659
"fields": {
8657-
"description": "List of fields with structural and profile information for each field.",
8660+
"description": "Output only. List of fields with structural and profile information for each field.",
86588661
"items": {
86598662
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileField"
86608663
},
8664+
"readOnly": true,
86618665
"type": "array"
86628666
}
86638667
},
@@ -8668,19 +8672,23 @@
86688672
"id": "GoogleCloudDataplexV1DataProfileResultProfileField",
86698673
"properties": {
86708674
"mode": {
8671-
"description": "The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.",
8675+
"description": "Output only. The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.",
8676+
"readOnly": true,
86728677
"type": "string"
86738678
},
86748679
"name": {
8675-
"description": "The name of the field.",
8680+
"description": "Output only. The name of the field.",
8681+
"readOnly": true,
86768682
"type": "string"
86778683
},
86788684
"profile": {
86798685
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo",
8680-
"description": "Profile information for the corresponding field."
8686+
"description": "Output only. Profile information for the corresponding field.",
8687+
"readOnly": true
86818688
},
86828689
"type": {
8683-
"description": "The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). For a Dataplex Universal Catalog Entity, it is the Entity Schema (https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).",
8690+
"description": "Output only. The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). For a Dataplex Universal Catalog Entity, it is the Entity Schema (https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).",
8691+
"readOnly": true,
86848692
"type": "string"
86858693
}
86868694
},
@@ -8691,8 +8699,9 @@
86918699
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo",
86928700
"properties": {
86938701
"distinctRatio": {
8694-
"description": "Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.",
8702+
"description": "Output only. Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.",
86958703
"format": "double",
8704+
"readOnly": true,
86968705
"type": "number"
86978706
},
86988707
"doubleProfile": {
@@ -8704,19 +8713,21 @@
87048713
"description": "Integer type field information."
87058714
},
87068715
"nullRatio": {
8707-
"description": "Ratio of rows with null value against total scanned rows.",
8716+
"description": "Output only. Ratio of rows with null value against total scanned rows.",
87088717
"format": "double",
8718+
"readOnly": true,
87098719
"type": "number"
87108720
},
87118721
"stringProfile": {
87128722
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo",
87138723
"description": "String type field information."
87148724
},
87158725
"topNValues": {
8716-
"description": "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, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.",
8726+
"description": "Output only. 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, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.",
87178727
"items": {
87188728
"$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue"
87198729
},
8730+
"readOnly": true,
87208731
"type": "array"
87218732
}
87228733
},
@@ -8727,31 +8738,36 @@
87278738
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo",
87288739
"properties": {
87298740
"average": {
8730-
"description": "Average of non-null values in the scanned data. NaN, if the field has a NaN.",
8741+
"description": "Output only. Average of non-null values in the scanned data. NaN, if the field has a NaN.",
87318742
"format": "double",
8743+
"readOnly": true,
87328744
"type": "number"
87338745
},
87348746
"max": {
8735-
"description": "Maximum of non-null values in the scanned data. NaN, if the field has a NaN.",
8747+
"description": "Output only. Maximum of non-null values in the scanned data. NaN, if the field has a NaN.",
87368748
"format": "double",
8749+
"readOnly": true,
87378750
"type": "number"
87388751
},
87398752
"min": {
8740-
"description": "Minimum of non-null values in the scanned data. NaN, if the field has a NaN.",
8753+
"description": "Output only. Minimum of non-null values in the scanned data. NaN, if the field has a NaN.",
87418754
"format": "double",
8755+
"readOnly": true,
87428756
"type": "number"
87438757
},
87448758
"quartiles": {
8745-
"description": "A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.",
8759+
"description": "Output only. A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of quartile values for the scanned data, occurring in order Q1, median, Q3.",
87468760
"items": {
87478761
"format": "double",
87488762
"type": "number"
87498763
},
8764+
"readOnly": true,
87508765
"type": "array"
87518766
},
87528767
"standardDeviation": {
8753-
"description": "Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.",
8768+
"description": "Output only. Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.",
87548769
"format": "double",
8770+
"readOnly": true,
87558771
"type": "number"
87568772
}
87578773
},
@@ -8762,31 +8778,36 @@
87628778
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo",
87638779
"properties": {
87648780
"average": {
8765-
"description": "Average of non-null values in the scanned data. NaN, if the field has a NaN.",
8781+
"description": "Output only. Average of non-null values in the scanned data. NaN, if the field has a NaN.",
87668782
"format": "double",
8783+
"readOnly": true,
87678784
"type": "number"
87688785
},
87698786
"max": {
8770-
"description": "Maximum of non-null values in the scanned data. NaN, if the field has a NaN.",
8787+
"description": "Output only. Maximum of non-null values in the scanned data. NaN, if the field has a NaN.",
87718788
"format": "int64",
8789+
"readOnly": true,
87728790
"type": "string"
87738791
},
87748792
"min": {
8775-
"description": "Minimum of non-null values in the scanned data. NaN, if the field has a NaN.",
8793+
"description": "Output only. Minimum of non-null values in the scanned data. NaN, if the field has a NaN.",
87768794
"format": "int64",
8795+
"readOnly": true,
87778796
"type": "string"
87788797
},
87798798
"quartiles": {
8780-
"description": "A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of approximate quartile values for the scanned data, occurring in order Q1, median, Q3.",
8799+
"description": "Output only. A quartile divides the number of data points into four parts, or quarters, of more-or-less equal size. Three main quartiles used are: The first quartile (Q1) splits off the lowest 25% of data from the highest 75%. It is also known as the lower or 25th empirical quartile, as 25% of the data is below this point. The second quartile (Q2) is the median of a data set. So, 50% of the data lies below this point. The third quartile (Q3) splits off the highest 25% of data from the lowest 75%. It is known as the upper or 75th empirical quartile, as 75% of the data lies below this point. Here, the quartiles is provided as an ordered list of approximate quartile values for the scanned data, occurring in order Q1, median, Q3.",
87818800
"items": {
87828801
"format": "int64",
87838802
"type": "string"
87848803
},
8804+
"readOnly": true,
87858805
"type": "array"
87868806
},
87878807
"standardDeviation": {
8788-
"description": "Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.",
8808+
"description": "Output only. Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN.",
87898809
"format": "double",
8810+
"readOnly": true,
87908811
"type": "number"
87918812
}
87928813
},
@@ -8797,18 +8818,21 @@
87978818
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo",
87988819
"properties": {
87998820
"averageLength": {
8800-
"description": "Average length of non-null values in the scanned data.",
8821+
"description": "Output only. Average length of non-null values in the scanned data.",
88018822
"format": "double",
8823+
"readOnly": true,
88028824
"type": "number"
88038825
},
88048826
"maxLength": {
8805-
"description": "Maximum length of non-null values in the scanned data.",
8827+
"description": "Output only. Maximum length of non-null values in the scanned data.",
88068828
"format": "int64",
8829+
"readOnly": true,
88078830
"type": "string"
88088831
},
88098832
"minLength": {
8810-
"description": "Minimum length of non-null values in the scanned data.",
8833+
"description": "Output only. Minimum length of non-null values in the scanned data.",
88118834
"format": "int64",
8835+
"readOnly": true,
88128836
"type": "string"
88138837
}
88148838
},
@@ -8819,17 +8843,20 @@
88198843
"id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue",
88208844
"properties": {
88218845
"count": {
8822-
"description": "Count of the corresponding value in the scanned data.",
8846+
"description": "Output only. Count of the corresponding value in the scanned data.",
88238847
"format": "int64",
8848+
"readOnly": true,
88248849
"type": "string"
88258850
},
88268851
"ratio": {
8827-
"description": "Ratio of the corresponding value in the field against the total number of rows in the scanned data.",
8852+
"description": "Output only. Ratio of the corresponding value in the field against the total number of rows in the scanned data.",
88288853
"format": "double",
8854+
"readOnly": true,
88298855
"type": "number"
88308856
},
88318857
"value": {
8832-
"description": "String value of a top N non-null value.",
8858+
"description": "Output only. String value of a top N non-null value.",
8859+
"readOnly": true,
88338860
"type": "string"
88348861
}
88358862
},
@@ -8852,7 +8879,7 @@
88528879
"description": "Optional. Actions to take upon job completion.."
88538880
},
88548881
"rowFilter": {
8855-
"description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#where_clause).Example: col1 >= 0 AND col2 < 10",
8882+
"description": "Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0 AND col2 < 10",
88568883
"type": "string"
88578884
},
88588885
"samplingPercent": {
@@ -8879,7 +8906,7 @@
88798906
"id": "GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport",
88808907
"properties": {
88818908
"resultsTable": {
8882-
"description": "Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
8909+
"description": "Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID",
88838910
"type": "string"
88848911
}
88858912
},
@@ -8935,7 +8962,8 @@
89358962
"id": "GoogleCloudDataplexV1DataQualityDimension",
89368963
"properties": {
89378964
"name": {
8938-
"description": "Optional. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.",
8965+
"description": "Output only. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters.",
8966+
"readOnly": true,
89398967
"type": "string"
89408968
}
89418969
},
@@ -12854,15 +12882,18 @@
1285412882
"id": "GoogleCloudDataplexV1ScannedDataIncrementalField",
1285512883
"properties": {
1285612884
"end": {
12857-
"description": "Value that marks the end of the range.",
12885+
"description": "Output only. Value that marks the end of the range.",
12886+
"readOnly": true,
1285812887
"type": "string"
1285912888
},
1286012889
"field": {
12861-
"description": "The field that contains values which monotonically increases over time (e.g. a timestamp column).",
12890+
"description": "Output only. The field that contains values which monotonically increases over time (e.g. a timestamp column).",
12891+
"readOnly": true,
1286212892
"type": "string"
1286312893
},
1286412894
"start": {
12865-
"description": "Value that marks the start of the range.",
12895+
"description": "Output only. Value that marks the start of the range.",
12896+
"readOnly": true,
1286612897
"type": "string"
1286712898
}
1286812899
},

0 commit comments

Comments
 (0)