|
7211 | 7211 | } |
7212 | 7212 | } |
7213 | 7213 | }, |
7214 | | - "revision": "20250805", |
| 7214 | + "revision": "20250808", |
7215 | 7215 | "rootUrl": "https://dataplex.googleapis.com/", |
7216 | 7216 | "schemas": { |
7217 | 7217 | "Empty": { |
|
8594 | 8594 | }, |
8595 | 8595 | "profile": { |
8596 | 8596 | "$ref": "GoogleCloudDataplexV1DataProfileResultProfile", |
8597 | | - "description": "The profile information per field." |
| 8597 | + "description": "Output only. The profile information per field.", |
| 8598 | + "readOnly": true |
8598 | 8599 | }, |
8599 | 8600 | "rowCount": { |
8600 | | - "description": "The count of rows scanned.", |
| 8601 | + "description": "Output only. The count of rows scanned.", |
8601 | 8602 | "format": "int64", |
| 8603 | + "readOnly": true, |
8602 | 8604 | "type": "string" |
8603 | 8605 | }, |
8604 | 8606 | "scannedData": { |
8605 | 8607 | "$ref": "GoogleCloudDataplexV1ScannedData", |
8606 | | - "description": "The data scanned for this result." |
| 8608 | + "description": "Output only. The data scanned for this result.", |
| 8609 | + "readOnly": true |
8607 | 8610 | } |
8608 | 8611 | }, |
8609 | 8612 | "type": "object" |
|
8654 | 8657 | "id": "GoogleCloudDataplexV1DataProfileResultProfile", |
8655 | 8658 | "properties": { |
8656 | 8659 | "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.", |
8658 | 8661 | "items": { |
8659 | 8662 | "$ref": "GoogleCloudDataplexV1DataProfileResultProfileField" |
8660 | 8663 | }, |
| 8664 | + "readOnly": true, |
8661 | 8665 | "type": "array" |
8662 | 8666 | } |
8663 | 8667 | }, |
|
8668 | 8672 | "id": "GoogleCloudDataplexV1DataProfileResultProfileField", |
8669 | 8673 | "properties": { |
8670 | 8674 | "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, |
8672 | 8677 | "type": "string" |
8673 | 8678 | }, |
8674 | 8679 | "name": { |
8675 | | - "description": "The name of the field.", |
| 8680 | + "description": "Output only. The name of the field.", |
| 8681 | + "readOnly": true, |
8676 | 8682 | "type": "string" |
8677 | 8683 | }, |
8678 | 8684 | "profile": { |
8679 | 8685 | "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo", |
8680 | | - "description": "Profile information for the corresponding field." |
| 8686 | + "description": "Output only. Profile information for the corresponding field.", |
| 8687 | + "readOnly": true |
8681 | 8688 | }, |
8682 | 8689 | "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, |
8684 | 8692 | "type": "string" |
8685 | 8693 | } |
8686 | 8694 | }, |
|
8691 | 8699 | "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo", |
8692 | 8700 | "properties": { |
8693 | 8701 | "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.", |
8695 | 8703 | "format": "double", |
| 8704 | + "readOnly": true, |
8696 | 8705 | "type": "number" |
8697 | 8706 | }, |
8698 | 8707 | "doubleProfile": { |
|
8704 | 8713 | "description": "Integer type field information." |
8705 | 8714 | }, |
8706 | 8715 | "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.", |
8708 | 8717 | "format": "double", |
| 8718 | + "readOnly": true, |
8709 | 8719 | "type": "number" |
8710 | 8720 | }, |
8711 | 8721 | "stringProfile": { |
8712 | 8722 | "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo", |
8713 | 8723 | "description": "String type field information." |
8714 | 8724 | }, |
8715 | 8725 | "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.", |
8717 | 8727 | "items": { |
8718 | 8728 | "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue" |
8719 | 8729 | }, |
| 8730 | + "readOnly": true, |
8720 | 8731 | "type": "array" |
8721 | 8732 | } |
8722 | 8733 | }, |
|
8727 | 8738 | "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo", |
8728 | 8739 | "properties": { |
8729 | 8740 | "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.", |
8731 | 8742 | "format": "double", |
| 8743 | + "readOnly": true, |
8732 | 8744 | "type": "number" |
8733 | 8745 | }, |
8734 | 8746 | "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.", |
8736 | 8748 | "format": "double", |
| 8749 | + "readOnly": true, |
8737 | 8750 | "type": "number" |
8738 | 8751 | }, |
8739 | 8752 | "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.", |
8741 | 8754 | "format": "double", |
| 8755 | + "readOnly": true, |
8742 | 8756 | "type": "number" |
8743 | 8757 | }, |
8744 | 8758 | "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.", |
8746 | 8760 | "items": { |
8747 | 8761 | "format": "double", |
8748 | 8762 | "type": "number" |
8749 | 8763 | }, |
| 8764 | + "readOnly": true, |
8750 | 8765 | "type": "array" |
8751 | 8766 | }, |
8752 | 8767 | "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.", |
8754 | 8769 | "format": "double", |
| 8770 | + "readOnly": true, |
8755 | 8771 | "type": "number" |
8756 | 8772 | } |
8757 | 8773 | }, |
|
8762 | 8778 | "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo", |
8763 | 8779 | "properties": { |
8764 | 8780 | "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.", |
8766 | 8782 | "format": "double", |
| 8783 | + "readOnly": true, |
8767 | 8784 | "type": "number" |
8768 | 8785 | }, |
8769 | 8786 | "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.", |
8771 | 8788 | "format": "int64", |
| 8789 | + "readOnly": true, |
8772 | 8790 | "type": "string" |
8773 | 8791 | }, |
8774 | 8792 | "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.", |
8776 | 8794 | "format": "int64", |
| 8795 | + "readOnly": true, |
8777 | 8796 | "type": "string" |
8778 | 8797 | }, |
8779 | 8798 | "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.", |
8781 | 8800 | "items": { |
8782 | 8801 | "format": "int64", |
8783 | 8802 | "type": "string" |
8784 | 8803 | }, |
| 8804 | + "readOnly": true, |
8785 | 8805 | "type": "array" |
8786 | 8806 | }, |
8787 | 8807 | "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.", |
8789 | 8809 | "format": "double", |
| 8810 | + "readOnly": true, |
8790 | 8811 | "type": "number" |
8791 | 8812 | } |
8792 | 8813 | }, |
|
8797 | 8818 | "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo", |
8798 | 8819 | "properties": { |
8799 | 8820 | "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.", |
8801 | 8822 | "format": "double", |
| 8823 | + "readOnly": true, |
8802 | 8824 | "type": "number" |
8803 | 8825 | }, |
8804 | 8826 | "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.", |
8806 | 8828 | "format": "int64", |
| 8829 | + "readOnly": true, |
8807 | 8830 | "type": "string" |
8808 | 8831 | }, |
8809 | 8832 | "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.", |
8811 | 8834 | "format": "int64", |
| 8835 | + "readOnly": true, |
8812 | 8836 | "type": "string" |
8813 | 8837 | } |
8814 | 8838 | }, |
|
8819 | 8843 | "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue", |
8820 | 8844 | "properties": { |
8821 | 8845 | "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.", |
8823 | 8847 | "format": "int64", |
| 8848 | + "readOnly": true, |
8824 | 8849 | "type": "string" |
8825 | 8850 | }, |
8826 | 8851 | "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.", |
8828 | 8853 | "format": "double", |
| 8854 | + "readOnly": true, |
8829 | 8855 | "type": "number" |
8830 | 8856 | }, |
8831 | 8857 | "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, |
8833 | 8860 | "type": "string" |
8834 | 8861 | } |
8835 | 8862 | }, |
|
8852 | 8879 | "description": "Optional. Actions to take upon job completion.." |
8853 | 8880 | }, |
8854 | 8881 | "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", |
8856 | 8883 | "type": "string" |
8857 | 8884 | }, |
8858 | 8885 | "samplingPercent": { |
|
8879 | 8906 | "id": "GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport", |
8880 | 8907 | "properties": { |
8881 | 8908 | "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", |
8883 | 8910 | "type": "string" |
8884 | 8911 | } |
8885 | 8912 | }, |
|
8935 | 8962 | "id": "GoogleCloudDataplexV1DataQualityDimension", |
8936 | 8963 | "properties": { |
8937 | 8964 | "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, |
8939 | 8967 | "type": "string" |
8940 | 8968 | } |
8941 | 8969 | }, |
@@ -12854,15 +12882,18 @@ |
12854 | 12882 | "id": "GoogleCloudDataplexV1ScannedDataIncrementalField", |
12855 | 12883 | "properties": { |
12856 | 12884 | "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, |
12858 | 12887 | "type": "string" |
12859 | 12888 | }, |
12860 | 12889 | "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, |
12862 | 12892 | "type": "string" |
12863 | 12893 | }, |
12864 | 12894 | "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, |
12866 | 12897 | "type": "string" |
12867 | 12898 | } |
12868 | 12899 | }, |
|
0 commit comments