--- title: "POST /v1/{+parent}/dataScans" method: POST path: "/v1/{+parent}/dataScans" tags: ["projects"] --- # POST /v1/{+parent}/dataScans `POST /v1/{+parent}/dataScans` Creates a DataScan resource. ## Path parameters - `parent` string, required ## Query parameters - `dataScanId` string - `validateOnly` boolean ## Request body - GoogleCloudDataplexV1DataScan — Represents a user-visible job which provides the insights for the related data source.For example: Data quality: generates queries based on the rules and runs against the data to get data quality check results. For more information, see Auto data quality overview (https://cloud.google.com/dataplex/docs/auto-data-quality-overview). Data profile: analyzes the data in tables and generates insights about the structure, content and relationships (such as null percent, cardinality, min/max/mean, etc). For more information, see About data profiling (https://cloud.google.com/dataplex/docs/data-profiling-overview). Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data (https://cloud.google.com/bigquery/docs/automatic-discovery). Data documentation: analyzes the table or dataset metadata and generates insights. For tables, insights include descriptions and sample SQL queries. For datasets, insights include descriptions, schema relationships and sample SQL queries. For more information, see Generate data insights in BigQuery (https://cloud.google.com/bigquery/docs/data-insights). - `displayName` string — Optional. User friendly display name. Must be between 1-256 characters. - `dataProfileResult` GoogleCloudDataplexV1DataProfileResult — DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. - `scannedData` GoogleCloudDataplexV1ScannedData — The data scanned during processing (e.g. in incremental DataScan) - `incrementalField` GoogleCloudDataplexV1ScannedDataIncrementalField — A data range denoted by a pair of start/end values of a field. - `field` string — Output only. The field that contains values which monotonically increases over time (e.g. a timestamp column). - `end` string — Output only. Value that marks the end of the range. - `start` string — Output only. Value that marks the start of the range. - `profile` GoogleCloudDataplexV1DataProfileResultProfile — Contains name, type, mode and field type specific profile information. - `fields` GoogleCloudDataplexV1DataProfileResultProfileField[] — Output only. List of fields with structural and profile information for each field. - `name` string — Output only. The name of the field. - `type` string — 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). - `mode` string — 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. - `profile` GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo — The profile information for each field type. - `nullRatio` number, double — Output only. Ratio of rows with null value against total scanned rows. - `stringProfile` GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo — The profile information for a string type field. - `averageLength` number, double — Output only. Average length of non-null values in the scanned data. - `maxLength` string, int64 — Output only. Maximum length of non-null values in the scanned data. - `minLength` string, int64 — Output only. Minimum length of non-null values in the scanned data. - `doubleProfile` GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo — The profile information for a double type field. - `min` number, double — Output only. Minimum of non-null values in the scanned data. NaN, if the field has a NaN. - `max` number, double — Output only. Maximum of non-null values in the scanned data. NaN, if the field has a NaN. - `average` number, double — Output only. Average of non-null values in the scanned data. NaN, if the field has a NaN. - `quartiles` number[] — 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. - `standardDeviation` number, double — Output only. Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN. - `topNValues` GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue[] — 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. - `value` string — Output only. String value of a top N non-null value. - `ratio` number, double — Output only. Ratio of the corresponding value in the field against the total number of rows in the scanned data. - `count` string, int64 — Output only. Count of the corresponding value in the scanned data. - `integerProfile` GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo — The profile information for an integer type field. - `standardDeviation` number, double — Output only. Standard deviation of non-null values in the scanned data. NaN, if the field has a NaN. - `quartiles` string[] — 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. - `average` number, double — Output only. Average of non-null values in the scanned data. NaN, if the field has a NaN. - `min` string, int64 — Output only. Minimum of non-null values in the scanned data. NaN, if the field has a NaN. - `max` string, int64 — Output only. Maximum of non-null values in the scanned data. NaN, if the field has a NaN. - `distinctRatio` number, double — 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. - `rowCount` string, int64 — Output only. The count of rows scanned. - `postScanActionsResult` GoogleCloudDataplexV1DataProfileResultPostScanActionsResult — The result of post scan actions of DataProfileScan job. - `bigqueryExportResult` GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult — The result of BigQuery export post scan action. - `state` 'STATE_UNSPECIFIED' | 'SUCCEEDED' | 'FAILED' | 'SKIPPED' — Output only. Execution state for the BigQuery exporting. - `message` string — Output only. Additional information about the BigQuery exporting. - `catalogPublishingStatus` GoogleCloudDataplexV1DataScanCatalogPublishingStatus — The status of publishing the data scan result as Dataplex Universal Catalog metadata. Multiple DataScan log events may exist, each with different publishing information depending on the type of publishing triggered. - `state` 'STATE_UNSPECIFIED' | 'SUCCEEDED' | 'FAILED' | 'SKIPPED' — Output only. Execution state for publishing. - `dataDiscoveryResult` GoogleCloudDataplexV1DataDiscoveryResult — The output of a data discovery scan. - `bigqueryPublishing` GoogleCloudDataplexV1DataDiscoveryResultBigQueryPublishing — Describes BigQuery publishing configurations. - `dataset` string — Output only. The BigQuery dataset the discovered tables are published to. - `location` string — Output only. The location of the BigQuery publishing dataset. - `scanStatistics` GoogleCloudDataplexV1DataDiscoveryResultScanStatistics — Describes result statistics of a data scan discovery job. - `dataProcessedBytes` string, int64 — The data processed in bytes. - `tablesUpdated` integer — The number of tables updated. - `tablesCreated` integer — The number of tables created. - `filesetsDeleted` integer — The number of filesets deleted. - `scannedFileCount` integer — The number of files scanned. - `filesetsCreated` integer — The number of filesets created. - `tablesDeleted` integer — The number of tables deleted. - `filesetsUpdated` integer — The number of filesets updated. - `filesExcluded` integer — The number of files excluded. - `labels` object — Optional. User-defined labels for the scan. - `executionIdentity` GoogleCloudDataplexV1ExecutionIdentity — The identity to run the datascan. - `dataplexServiceAgent` GoogleCloudDataplexV1ExecutionIdentityDataplexServiceAgent — The Dataplex service agent associated with the user's project. - `userCredential` GoogleCloudDataplexV1ExecutionIdentityUserCredential — The credential of the calling user. - `serviceAccount` GoogleCloudDataplexV1ExecutionIdentityServiceAccount — The service account - `email` string — Required. Service account email. The datascan will execute with this service account's credentials. The user calling this API must have permissions to act as this service account. Dataplex service agent must be granted iam.serviceAccounts.getAccessToken permission on this service account, for example, through the iam.serviceAccountTokenCreator role . - `dataDocumentationSpec` GoogleCloudDataplexV1DataDocumentationSpec — DataDocumentation scan related spec. - `catalogPublishingEnabled` boolean — Optional. Whether to publish result to Dataplex Catalog. - `generationScopes` string[] — Optional. Specifies which components of the data documentation to generate. Any component that is required to generate the specified components will also be generated. If no generation scope is specified, all available documentation components will be generated. - `uid` string — Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name. - `executionStatus` GoogleCloudDataplexV1DataScanExecutionStatus — Status of the data scan execution. - `latestJobCreateTime` string, google-datetime — Optional. The time when the DataScanJob execution was created. - `latestJobStartTime` string, google-datetime — Optional. The time when the latest DataScanJob started. - `latestJobEndTime` string, google-datetime — Optional. The time when the latest DataScanJob ended. - `dataQualitySpec` GoogleCloudDataplexV1DataQualitySpec — DataQualityScan related setting. - `samplingPercent` number, float — 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. - `postScanActions` GoogleCloudDataplexV1DataQualitySpecPostScanActions — The configuration of post scan actions of DataQualityScan. - `notificationReport` GoogleCloudDataplexV1DataQualitySpecPostScanActionsNotificationReport — The configuration of notification report post scan action. - `jobEndTrigger` GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobEndTrigger — This trigger is triggered whenever a scan job run ends, regardless of the result. - `scoreThresholdTrigger` GoogleCloudDataplexV1DataQualitySpecPostScanActionsScoreThresholdTrigger — This trigger is triggered when the DQ score in the job result is less than a specified input score. - `scoreThreshold` number, float — Optional. The score range is in 0,100. - `recipients` GoogleCloudDataplexV1DataQualitySpecPostScanActionsRecipients — The individuals or groups who are designated to receive notifications upon triggers. - `emails` string[] — Optional. The email recipients who will receive the DataQualityScan results report. - `jobFailureTrigger` GoogleCloudDataplexV1DataQualitySpecPostScanActionsJobFailureTrigger — This trigger is triggered when the scan job itself fails, regardless of the result. - `bigqueryExport` GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport — The configuration of BigQuery export post scan action. - `resultsTable` string — Optional. The BigQuery table to export DataQualityScan 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 - `rules` GoogleCloudDataplexV1DataQualityRule[] — Required. The list of rules to evaluate against a data source. At least one rule is required. - `ignoreNull` boolean — 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 - `regexExpectation` GoogleCloudDataplexV1DataQualityRuleRegexExpectation — Evaluates whether each column value matches a specified regex. - `regex` string — Optional. A regular expression the column value is expected to match. - `attributes` object — Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. - `debugQueries` GoogleCloudDataplexV1DataQualityRuleDebugQuery[] — Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. - `description` string — Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. - `sqlStatement` string — Required. Specifies the SQL statement to be executed. - `tableConditionExpectation` GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation — Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 - `sqlExpression` string — Optional. The SQL expression. - `templateReference` GoogleCloudDataplexV1DataQualityRuleTemplateReference — A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails - `values` object — Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). - `resolvedSql` string — Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. - `ruleTemplate` GoogleCloudDataplexV1DataQualityRuleTemplate — DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. - `sqlCollection` GoogleCloudDataplexV1DataQualityRuleTemplateSql[] — Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. - `query` string — Output only. Templatized SQL query for data quality rules. - `inputParameters` object — Output only. Description for input parameters - `capabilities` string[] — Output only. A list of features or properties supported by this rule template. - `name` string — Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} - `dimension` string — Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. - `name` string — Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} - `rangeExpectation` GoogleCloudDataplexV1DataQualityRuleRangeExpectation — Evaluates whether each column value lies between a specified range. - `minValue` string — 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. - `maxValue` string — 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. - `strictMinEnabled` boolean — Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. - `strictMaxEnabled` boolean — Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. - `suspended` boolean — Optional. Whether the Rule is active or suspended. Default is false. - `setExpectation` GoogleCloudDataplexV1DataQualityRuleSetExpectation — Evaluates whether each column value is contained by a specified set. - `values` string[] — Optional. Expected values for the column value. - `statisticRangeExpectation` GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation — Evaluates whether the column aggregate statistic lies between a specified range. - `statistic` 'STATISTIC_UNDEFINED' | 'MEAN' | 'MIN' | 'MAX' — Optional. The aggregate metric to evaluate. - `maxValue` string — 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. - `strictMaxEnabled` boolean — Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. - `strictMinEnabled` boolean — Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. - `minValue` string — 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. - `sqlAssertion` GoogleCloudDataplexV1DataQualityRuleSqlAssertion — A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: SELECT * FROM ${data()} WHERE price < 0 - `sqlStatement` string — Optional. The SQL statement. - `dimension` string — Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. - `nonNullExpectation` GoogleCloudDataplexV1DataQualityRuleNonNullExpectation — Evaluates whether each column value is null. - `ruleSource` GoogleCloudDataplexV1DataQualityRuleRuleSource — Represents the rule source information from Catalog. - `rulePathElements` GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement[] — Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. - `entryLinkSource` GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource — Entry link source represents information about the entry link. - `entryLinkType` string — Output only. The entry link type to represent the current relationship between the entry and the next entry in the path. In the form of: projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id} - `entryLink` string — Output only. The entry link name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id} - `entrySource` GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource — Entry source represents information about the related source entry. - `entryType` string — Output only. The entry type to represent the current characteristics of the entry in the form of: projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry-type-id}. - `displayName` string — Output only. The display name of the entry. - `entry` string — Output only. The entry name in the form of: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} - `rowConditionExpectation` GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation — Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 - `sqlExpression` string — Optional. The SQL expression. - `threshold` number, double — 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. - `name` string — 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. - `description` string — Optional. Description of the rule. The maximum length is 1,024 characters. - `column` string — Optional. The unnested column which this rule is evaluated against. - `uniquenessExpectation` GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation — Evaluates whether the column has duplicates. - `filter` string — Optional. Filter for selectively running a subset of rules. You can filter the request by the name or attribute key-value pairs defined on the rule. If not specified, all rules are run. The filter is applicable to both, the rules retrieved from catalog and explicitly defined rules in the scan. Please see filter syntax (https://docs.cloud.google.com/dataplex/docs/auto-data-quality-overview#rule-filtering) for more details. - `catalogPublishingEnabled` boolean — Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. - `rowFilter` string — 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 - `enableCatalogBasedRules` boolean — Optional. If enabled, the data scan will retrieve rules defined in the dataplex-types.global.data-rules aspect on all paths of the catalog entry corresponding to the BigQuery table resource and all attached glossary terms. The path that data-rules aspect is attached on the table entry defines the column that the rule will be evaluated against. For glossary terms, the path that the terms are attached on the table entry defines the column that the rule will be evaluated against. At the start of scan execution, the rules reflect the latest state retrieved from the catalog entry and any updates on the rules thereafter are ignored for that execution. The updates will be reflected from the next execution. Rules defined in the datascan must be empty if this field is enabled. - `dataDocumentationResult` GoogleCloudDataplexV1DataDocumentationResult — The output of a DataDocumentation scan. - `datasetResult` GoogleCloudDataplexV1DataDocumentationResultDatasetResult — Insights for a dataset resource. - `overview` string — Output only. Generated Dataset description. - `queries` GoogleCloudDataplexV1DataDocumentationResultQuery[] — Output only. Sample SQL queries for the dataset. - `description` string — Output only. The description for the query. - `sql` string — Output only. The SQL query string which can be executed. - `schemaRelationships` GoogleCloudDataplexV1DataDocumentationResultSchemaRelationship[] — Output only. Relationships suggesting how tables in the dataset are related to each other, based on their schema. - `leftSchemaPaths` GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths — Represents an ordered set of paths within a table's schema. - `tableFqn` string — Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID - `paths` string[] — Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field - `rightSchemaPaths` GoogleCloudDataplexV1DataDocumentationResultSchemaRelationshipSchemaPaths — Represents an ordered set of paths within a table's schema. - `tableFqn` string — Output only. The service-qualified full resource name of the table Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID - `paths` string[] — Output only. An ordered set of Paths to fields within the schema of the table. For fields nested within a top level field of type record, use '.' to separate field names. Examples: Top level field - top_level Nested field - top_level.child.sub_field - `sources` string[] — Output only. Sources which generated the schema relation edge. - `type` 'TYPE_UNSPECIFIED' | 'SCHEMA_JOIN' — Output only. The type of relationship between the schema paths. - `tableResult` GoogleCloudDataplexV1DataDocumentationResultTableResult — Insights for a table resource. - `name` string — Output only. The service-qualified full resource name of the cloud resource. Ex: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID - `overview` string — Output only. Generated description of the table. - `schema` GoogleCloudDataplexV1DataDocumentationResultSchema — Schema of the table with generated metadata of columns. - `fields` GoogleCloudDataplexV1DataDocumentationResultField[] — Output only. The list of columns. - `fields` GoogleCloudDataplexV1DataDocumentationResultField[] — Output only. Nested fields. - `name` string — Output only. The name of the column. - `description` string — Output only. Generated description for columns and fields. - `queries` GoogleCloudDataplexV1DataDocumentationResultQuery[] — Output only. Sample SQL queries for the table. - `description` string — Output only. The description for the query. - `sql` string — Output only. The SQL query string which can be executed. - `description` string — Optional. Description of the scan. Must be between 1-1024 characters. - `executionSpec` GoogleCloudDataplexV1DataScanExecutionSpec — DataScan execution settings. - `trigger` GoogleCloudDataplexV1Trigger — DataScan scheduling and trigger settings. - `onDemand` GoogleCloudDataplexV1TriggerOnDemand — The scan runs once via RunDataScan API. - `oneTime` GoogleCloudDataplexV1TriggerOneTime — The scan runs once using create API. - `ttlAfterScanCompletion` string, google-duration — Optional. Time to live for OneTime scans. default value is 24 hours, minimum value is 0 seconds, and maximum value is 365 days. The time is calculated from the data scan job completion time. If value is set as 0 seconds, the scan will be immediately deleted upon job completion, regardless of whether the job succeeded or failed. - `schedule` GoogleCloudDataplexV1TriggerSchedule — The scan is scheduled to run periodically. - `cron` string — Required. Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans periodically.To explicitly set a timezone in the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database (wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)). For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.This field is required for Schedule scans. - `field` string — Immutable. The unnested field (of type Date or Timestamp) that contains values which monotonically increase over time.If not specified, a data scan will run for all data in the table. - `dataProfileSpec` GoogleCloudDataplexV1DataProfileSpec — DataProfileScan related setting. - `postScanActions` GoogleCloudDataplexV1DataProfileSpecPostScanActions — The configuration of post scan actions of DataProfileScan job. - `bigqueryExport` GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport — The configuration of BigQuery export post scan action. - `resultsTable` string — Optional. The BigQuery table to export DataProfileScan results to. Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID - `includeFields` GoogleCloudDataplexV1DataProfileSpecSelectedFields — The specification for fields to include or exclude in data profile scan. - `fieldNames` string[] — Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. - `samplingPercent` number, float — 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. - `mode` 'MODE_UNSPECIFIED' | 'STANDARD' | 'LIGHTWEIGHT' — Optional. The execution mode for the profile scan. - `excludeFields` GoogleCloudDataplexV1DataProfileSpecSelectedFields — The specification for fields to include or exclude in data profile scan. - `fieldNames` string[] — Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested field type, listing 'x' is supported but 'x.y.z' is not supported. Here 'y' and 'y.z' are nested fields of 'x'. - `catalogPublishingEnabled` boolean — Optional. If set, the latest DataScan job result will be published as Dataplex Universal Catalog metadata. - `rowFilter` string — 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 - `dataQualityResult` GoogleCloudDataplexV1DataQualityResult — The output of a DataQualityScan. - `score` number, float — Output only. The overall data quality score.The score ranges between 0, 100 (up to two decimal points). - `columns` GoogleCloudDataplexV1DataQualityColumnResult[] — 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 'column' field set to it. - `dimensions` GoogleCloudDataplexV1DataQualityDimensionResult[] — Output only. The dimension-level results for this column. - `dimension` GoogleCloudDataplexV1DataQualityDimension — A dimension captures data quality intent about a defined subset of the rules specified. - `name` string — Output only. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. - `score` number, float — Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). - `passed` boolean — Output only. Whether the dimension passed or failed. - `column` string — Output only. The column specified in the DataQualityRule. - `score` number, float — Output only. The column-level data quality score for this data scan job if and only if the 'column' field is set.The score ranges between between 0, 100 (up to two decimal points). - `passed` boolean — Output only. Whether the column passed or failed. - `postScanActionsResult` GoogleCloudDataplexV1DataQualityResultPostScanActionsResult — The result of post scan actions of DataQualityScan job. - `bigqueryExportResult` GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult — The result of BigQuery export post scan action. - `state` 'STATE_UNSPECIFIED' | 'SUCCEEDED' | 'FAILED' | 'SKIPPED' — Output only. Execution state for the BigQuery exporting. - `message` string — Output only. Additional information about the BigQuery exporting. - `dimensions` GoogleCloudDataplexV1DataQualityDimensionResult[] — Output only. 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 'dimension' field set to it. - `dimension` GoogleCloudDataplexV1DataQualityDimension — A dimension captures data quality intent about a defined subset of the rules specified. - `name` string — Output only. The dimension name a rule belongs to. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. - `score` number, float — Output only. The dimension-level data quality score for this data scan job if and only if the 'dimension' field is set.The score ranges between 0, 100 (up to two decimal points). - `passed` boolean — Output only. Whether the dimension passed or failed. - `passed` boolean — Output only. Overall data quality result -- true if all rules passed. - `catalogPublishingStatus` GoogleCloudDataplexV1DataScanCatalogPublishingStatus — The status of publishing the data scan result as Dataplex Universal Catalog metadata. Multiple DataScan log events may exist, each with different publishing information depending on the type of publishing triggered. - `state` 'STATE_UNSPECIFIED' | 'SUCCEEDED' | 'FAILED' | 'SKIPPED' — Output only. Execution state for publishing. - `rowCount` string, int64 — Output only. The count of rows processed. - `rules` GoogleCloudDataplexV1DataQualityRuleResult[] — Output only. A list of all the rules in a job, and their results. - `nullCount` string, int64 — Output only. The number of rows with null values in the specified column. - `assertionRowCount` string, int64 — Output only. The number of rows returned by the SQL statement in a SQL assertion rule.This field is only valid for SQL assertion rules. - `rule` GoogleCloudDataplexV1DataQualityRule — A rule captures data quality intent about a data source. - `ignoreNull` boolean — 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 - `regexExpectation` GoogleCloudDataplexV1DataQualityRuleRegexExpectation — Evaluates whether each column value matches a specified regex. - `regex` string — Optional. A regular expression the column value is expected to match. - `attributes` object — Optional. Map of attribute name and value linked to the rule. The rules to evaluate can be filtered based on attributes provided here and a filter expression provided in the DataQualitySpec.filter field. - `debugQueries` GoogleCloudDataplexV1DataQualityRuleDebugQuery[] — Optional. Specifies the debug queries for this rule. Currently, only one query is supported, but this may be expanded in the future. - `description` string — Optional. Specifies the description of the debug query. The maximum length is 1,024 characters. - `sqlStatement` string — Required. Specifies the SQL statement to be executed. - `tableConditionExpectation` GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation — Evaluates whether the provided expression is true.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a scalar boolean result.Example: MIN(col1) >= 0 - `sqlExpression` string — Optional. The SQL expression. - `templateReference` GoogleCloudDataplexV1DataQualityRuleTemplateReference — A rule that constructs a SQL statement to evaluate using a rule template and parameter values. If the constructed statement returns any rows, this rule fails - `values` object — Optional. Provides the map of parameter name and value. The maximum size of the field is 120KB (encoded as UTF-8). - `resolvedSql` string — Output only. The resolved SQL statement generated from the template with parameters substituted. It is only populated in the result. - `ruleTemplate` GoogleCloudDataplexV1DataQualityRuleTemplate — DataQualityRuleTemplate represents a template which can be reused across multiple data quality rules. - `sqlCollection` GoogleCloudDataplexV1DataQualityRuleTemplateSql[] — Output only. Collection of SQLs for data quality rules. Currently only one SQL is supported. - … - `inputParameters` object — Output only. Description for input parameters - `capabilities` string[] — Output only. A list of features or properties supported by this rule template. - `name` string — Output only. The name of the rule template in the format: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} - `dimension` string — Output only. The dimension a rule template belongs to. Rule level results are also aggregated at the dimension level. - `name` string — Required. The template entry name. Entry must be of EntryType projects/dataplex-types/locations/global/entryTypes/data-quality-rule-template and contains top-level aspect of AspectType projects/dataplex-types/locations/global/aspectTypes/data-quality-rule-template. The format is: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id} - `rangeExpectation` GoogleCloudDataplexV1DataQualityRuleRangeExpectation — Evaluates whether each column value lies between a specified range. - `minValue` string — 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. - `maxValue` string — 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. - `strictMinEnabled` boolean — Optional. Whether each value needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. - `strictMaxEnabled` boolean — Optional. Whether each value needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. - `suspended` boolean — Optional. Whether the Rule is active or suspended. Default is false. - `setExpectation` GoogleCloudDataplexV1DataQualityRuleSetExpectation — Evaluates whether each column value is contained by a specified set. - `values` string[] — Optional. Expected values for the column value. - `statisticRangeExpectation` GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation — Evaluates whether the column aggregate statistic lies between a specified range. - `statistic` 'STATISTIC_UNDEFINED' | 'MEAN' | 'MIN' | 'MAX' — Optional. The aggregate metric to evaluate. - `maxValue` string — 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. - `strictMaxEnabled` boolean — Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. - `strictMinEnabled` boolean — Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. - `minValue` string — 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. - `sqlAssertion` GoogleCloudDataplexV1DataQualityRuleSqlAssertion — A SQL statement that is evaluated to return rows that match an invalid state. If any rows are are returned, this rule fails.The SQL statement must use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax), and must not contain any semicolons.You can use the data reference parameter ${data()} to reference the source table with all of its precondition filters applied. Examples of precondition filters include row filters, incremental data filters, and sampling. For more information, see Data reference parameter (https://cloud.google.com/dataplex/docs/auto-data-quality-overview#data-reference-parameter).Example: SELECT * FROM ${data()} WHERE price < 0 - `sqlStatement` string — Optional. The SQL statement. - `dimension` string — Optional. The dimension a rule belongs to. Results are also aggregated at the dimension level. Custom dimension name is supported with all uppercase letters and maximum length of 30 characters. - `nonNullExpectation` GoogleCloudDataplexV1DataQualityRuleNonNullExpectation — Evaluates whether each column value is null. - `ruleSource` GoogleCloudDataplexV1DataQualityRuleRuleSource — Represents the rule source information from Catalog. - `rulePathElements` GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElement[] — Output only. Rule path elements represent information about the individual items in the relationship path between the scan resource and rule origin in that order. - `entryLinkSource` GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntryLinkSource — Entry link source represents information about the entry link. - … - `entrySource` GoogleCloudDataplexV1DataQualityRuleRuleSourceRulePathElementEntrySource — Entry source represents information about the related source entry. - … - `rowConditionExpectation` GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation — Evaluates whether each row passes the specified condition.The SQL expression needs to use GoogleSQL syntax (https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax) and should produce a boolean value per row as the result.Example: col1 >= 0 AND col2 < 10 - `sqlExpression` string — Optional. The SQL expression. - `threshold` number, double — 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. - `name` string — 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. - `description` string — Optional. Description of the rule. The maximum length is 1,024 characters. - `column` string — Optional. The unnested column which this rule is evaluated against. - `uniquenessExpectation` GoogleCloudDataplexV1DataQualityRuleUniquenessExpectation — Evaluates whether the column has duplicates. - `failingRowsQuery` string — Output only. The query to find rows that did not pass this rule.This field is only valid for row-level type rules. - `passedCount` string, int64 — Output only. The number of rows which passed a rule evaluation.This field is only valid for row-level type rules.This field is not set for rule SqlAssertion. - `evaluatedCount` string, int64 — Output only. 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.This field is not set for rule SqlAssertion. - `passed` boolean — Output only. Whether the rule passed or failed. - `passRatio` number, double — Output only. The ratio of passed_count / evaluated_count.This field is only valid for row-level type rules. - `debugQueriesResultSets` GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResultSet[] — Output only. Contains the results of all debug queries for this rule. The number of result sets will correspond to the number of debug_queries. - `results` GoogleCloudDataplexV1DataQualityRuleResultDebugQueryResult[] — Output only. Contains all results. Up to 10 results can be returned. - `name` string — Specifies the name of the result. Available if provided with an explicit alias using [AS] alias. - `type` string — Indicates the data type of the result. For more information, see BigQuery data types (https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types). - `value` string — Represents the value of the result as a string. - `anomalyDetectionGeneratedAssets` GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets — The assets generated by Anomaly Detection Data Scan. - `resultTable` string — Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table. - `freshnessIntermediateTable` string — Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID - `volumeIntermediateTable` string — Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID - `dataIntermediateTable` string — Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID - `scannedData` GoogleCloudDataplexV1ScannedData — The data scanned during processing (e.g. in incremental DataScan) - `incrementalField` GoogleCloudDataplexV1ScannedDataIncrementalField — A data range denoted by a pair of start/end values of a field. - `field` string — Output only. The field that contains values which monotonically increases over time (e.g. a timestamp column). - `end` string — Output only. Value that marks the end of the range. - `start` string — Output only. Value that marks the start of the range. - `name` string — Output only. Identifier. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a Google Cloud region. - `dataDiscoverySpec` GoogleCloudDataplexV1DataDiscoverySpec — Spec for a data discovery scan. - `bigqueryPublishingConfig` GoogleCloudDataplexV1DataDiscoverySpecBigQueryPublishingConfig — Describes BigQuery publishing configurations. - `project` string — Optional. The project of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. If not specified, the project of the Cloud Storage bucket will be used. The format is "projects/{project_id_or_number}". - `location` string — Optional. The location of the BigQuery dataset to publish BigLake external or non-BigLake external tables to. 1. If the Cloud Storage bucket is located in a multi-region bucket, then BigQuery dataset can be in the same multi-region bucket or any single region that is included in the same multi-region bucket. The datascan can be created in any single region that is included in the same multi-region bucket 2. If the Cloud Storage bucket is located in a dual-region bucket, then BigQuery dataset can be located in regions that are included in the dual-region bucket, or in a multi-region that includes the dual-region. The datascan can be created in any single region that is included in the same dual-region bucket. 3. If the Cloud Storage bucket is located in a single region, then BigQuery dataset can be in the same single region or any multi-region bucket that includes the same single region. The datascan will be created in the same single region as the bucket. 4. If the BigQuery dataset is in single region, it must be in the same single region as the datascan.For supported values, refer to https://cloud.google.com/bigquery/docs/locations#supported_locations. - `tableType` 'TABLE_TYPE_UNSPECIFIED' | 'EXTERNAL' | 'BIGLAKE' — Optional. Determines whether to publish discovered tables as BigLake external tables or non-BigLake external tables. - `connection` string — Optional. The BigQuery connection used to create BigLake tables. Must be in the form projects/{project_id}/locations/{location_id}/connections/{connection_id} - `storageConfig` GoogleCloudDataplexV1DataDiscoverySpecStorageConfig — Configurations related to Cloud Storage as the data source. - `includePatterns` string[] — Optional. Defines the data to include during discovery when only a subset of the data should be considered. Provide a list of patterns that identify the data to include. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. - `csvOptions` GoogleCloudDataplexV1DataDiscoverySpecStorageConfigCsvOptions — Describes CSV and similar semi-structured data formats. - `headerRows` integer — Optional. The number of rows to interpret as header rows that should be skipped when reading data rows. - `typeInferenceDisabled` boolean — Optional. Whether to disable the inference of data types for CSV data. If true, all columns are registered as strings. - `delimiter` string — Optional. The delimiter that is used to separate values. The default is , (comma). - `encoding` string — Optional. The character encoding of the data. The default is UTF-8. - `quote` string — Optional. The character used to quote column values. Accepts " (double quotation mark) or ' (single quotation mark). If unspecified, defaults to " (double quotation mark). - `jsonOptions` GoogleCloudDataplexV1DataDiscoverySpecStorageConfigJsonOptions — Describes JSON data format. - `encoding` string — Optional. The character encoding of the data. The default is UTF-8. - `typeInferenceDisabled` boolean — Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean). - `unstructuredDataOptions` GoogleCloudDataplexV1DataDiscoverySpecStorageConfigUnstructuredDataOptions — Describes options for unstructured data discovery. - `semanticInferenceEnabled` boolean — Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled. - `globalEndpointEnabled` boolean — Optional. Whether to use the global model endpoint. - `excludePatterns` string[] — Optional. Defines the data to exclude during discovery. Provide a list of patterns that identify the data to exclude. For Cloud Storage bucket assets, these patterns are interpreted as glob patterns used to match object names. For BigQuery dataset assets, these patterns are interpreted as patterns to match table names. - `unstructuredDataProfileSpec` GoogleCloudDataplexV1UnstructuredDataProfileSpec — Contains the specification for an unstructured data profile scan. - `customizedPrompt` string — Optional. Customized prompt for unstructured data profile. The field will be used as part of the prompt, could be some instruction, specifying skill, or specific area to focus. - `globalEndpointEnabled` boolean — Optional. Whether to use the global model. - `graphProfilePublishingEnabled` boolean — Optional. Whether to publish graph-profile as aspect on the catalog entry. - `createTime` string, google-datetime — Output only. The time when the scan was created. - `data` GoogleCloudDataplexV1DataSource — The data source for DataScan. - `entity` string — Immutable. The Dataplex Universal Catalog 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}. - `resource` string — Immutable. The service-qualified full resource name of the cloud resource for a DataScan job to scan against. The field could either be: Cloud Storage bucket for DataDiscoveryScan Format: //storage.googleapis.com/projects/PROJECT_ID/buckets/BUCKET_ID or BigQuery table of type "TABLE" for DataProfileScan/DataQualityScan/DataDocumentationScan Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID or BigQuery dataset for DataDocumentationScan only Format: //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID - `updateTime` string, google-datetime — Output only. The time when the scan was last updated. - `state` 'STATE_UNSPECIFIED' | 'ACTIVE' | 'CREATING' | 'DELETING' | 'ACTION_REQUIRED' — Output only. Current state of the DataScan. - `type` 'DATA_SCAN_TYPE_UNSPECIFIED' | 'DATA_QUALITY' | 'DATA_PROFILE' | 'DATA_DISCOVERY' | 'DATA_DOCUMENTATION' | 'UNSTRUCTURED_DATA_PROFILE' — Output only. The type of DataScan. - `unstructuredDataProfileResult` GoogleCloudDataplexV1UnstructuredDataProfileResult — Contains the result of an unstructured data profile scan. - `partialFailureMessage` string — Output only. Optional message for partial failures (e.g. node type extraction failed). - `graphProfile` GoogleCloudDataplexV1GraphProfile — Contains the strict structure for graph-profile for semantic inference scan result. - `edgeTypes` GoogleCloudDataplexV1GraphProfileEdgeType[] — Output only. Edge types. - `name` string — Output only. Name of the edge type. - `foreignKeys` GoogleCloudDataplexV1GraphProfileEdgeTypeForeignKey[] — Output only. Defines the Foreign Key constraints for the edge. - `fieldMappings` GoogleCloudDataplexV1GraphProfileEdgeTypeForeignKeyFieldMapping[] — Output only. Field Mappings. Mappings between local fields and the fields they reference in the referenced node type. - `field` string — Output only. Local field name forming part of the foreign key. - `referencedField` string — Output only. Field name in the referenced node type. - `description` string — Output only. Description of the foreign key. - `referencedNodeType` string — Output only. The node type this constraint references. - `name` string — Output only. Name of the foreign key constraint. - `description` string — Output only. Description of the edge type. - `targetNodeType` string — Output only. Target node type. - `sourceNodeType` string — Output only. Source node type. - `fields` GoogleCloudDataplexV1GraphProfileField[] — Output only. Fields of the edge type. - `metadataType` 'METADATA_TYPE_UNSPECIFIED' | 'BOOLEAN' | 'NUMBER' | 'STRING' | 'BYTES' | 'DATETIME' | 'TIMESTAMP' | 'GEOSPATIAL' | 'STRUCT' | 'OTHER' — Output only. The mapped metadata type. - `extractionHints` GoogleCloudDataplexV1GraphProfileFieldExtractionHints — Extraction hints (field-level). - `normalization` string — Output only. Standardizes extracted data (e.g., to ISO 3166-1 alpha-2). - `synthesis` string — Output only. Generates value from other data instead of direct extraction (e.g., hashing). - `fields` GoogleCloudDataplexV1GraphProfileField[] — Output only. Sub-fields of this field (for STRUCT types). - `name` string — Output only. Name of the field. - `mode` 'MODE_UNSPECIFIED' | 'NULLABLE' | 'REPEATED' | 'REQUIRED' — Output only. The mode of the field. - `description` string — Output only. Description of the field. - `dataType` string — Output only. The data type of the field, e.g., STRING, INTEGER, DATE. - `extractionHints` GoogleCloudDataplexV1GraphProfileEdgeTypeExtractionHints — Extraction hints (edge-level). - `cardinality` string — Output only. Expected connectivity topology and bounds of this relationship. Format: "Topology - Description" Example: "1:N - One company can have multiple financial reports." - `nodeTypes` GoogleCloudDataplexV1GraphProfileNodeType[] — Output only. Node types. - `fields` GoogleCloudDataplexV1GraphProfileField[] — Output only. Fields of the node type. - `metadataType` 'METADATA_TYPE_UNSPECIFIED' | 'BOOLEAN' | 'NUMBER' | 'STRING' | 'BYTES' | 'DATETIME' | 'TIMESTAMP' | 'GEOSPATIAL' | 'STRUCT' | 'OTHER' — Output only. The mapped metadata type. - `extractionHints` GoogleCloudDataplexV1GraphProfileFieldExtractionHints — Extraction hints (field-level). - `normalization` string — Output only. Standardizes extracted data (e.g., to ISO 3166-1 alpha-2). - `synthesis` string — Output only. Generates value from other data instead of direct extraction (e.g., hashing). - `fields` GoogleCloudDataplexV1GraphProfileField[] — Output only. Sub-fields of this field (for STRUCT types). - `name` string — Output only. Name of the field. - `mode` 'MODE_UNSPECIFIED' | 'NULLABLE' | 'REPEATED' | 'REQUIRED' — Output only. The mode of the field. - `description` string — Output only. Description of the field. - `dataType` string — Output only. The data type of the field, e.g., STRING, INTEGER, DATE. - `extractionHints` GoogleCloudDataplexV1GraphProfileNodeTypeExtractionHints — Extraction hints (node-level). - `cardinality` string — Output only. Expected occurrence frequency of this node type within a document. Format: "Bounds - Description" Example: "0:N - A document may contain multiple people names." - `name` string — Output only. Name of the node type. - `primaryKeys` string[] — Output only. Field names forming the primary keys. The order in this array defines the key's ordinal positions for composite keys. - `description` string — Output only. Description of the node type. - `description` string — Output only. The inferred description. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/dataplex.md) · [All operations](https://skmtc.net/google/apis/dataplex/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dataplex/versions/43a3b60ca93b/schema)