public sealed class DataScan : IMessage<DataScan>, IEquatable<DataScan>, IDeepCloneable<DataScan>, IBufferMessage, IMessageReference documentation and code samples for the Cloud Dataplex v1 API class DataScan.
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.
- 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.
- Data discovery: scans data in Cloud Storage buckets to extract and then catalog metadata. For more information, see Discover and catalog Cloud Storage data.
- 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.
Namespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
DataScan()
public DataScan()DataScan(DataScan)
public DataScan(DataScan other)| Parameter | |
|---|---|
| Name | Description |
other |
DataScan |
Properties
CreateTime
public Timestamp CreateTime { get; set; }Output only. The time when the scan was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Data
public DataSource Data { get; set; }Required. The data source for DataScan.
| Property Value | |
|---|---|
| Type | Description |
DataSource |
|
DataDiscoveryResult
public DataDiscoveryResult DataDiscoveryResult { get; set; }Output only. The result of a data discovery scan.
| Property Value | |
|---|---|
| Type | Description |
DataDiscoveryResult |
|
DataDiscoverySpec
public DataDiscoverySpec DataDiscoverySpec { get; set; }Settings for a data discovery scan.
| Property Value | |
|---|---|
| Type | Description |
DataDiscoverySpec |
|
DataDocumentationResult
public DataDocumentationResult DataDocumentationResult { get; set; }Output only. The result of a data documentation scan.
| Property Value | |
|---|---|
| Type | Description |
DataDocumentationResult |
|
DataDocumentationSpec
public DataDocumentationSpec DataDocumentationSpec { get; set; }Settings for a data documentation scan.
| Property Value | |
|---|---|
| Type | Description |
DataDocumentationSpec |
|
DataProfileResult
public DataProfileResult DataProfileResult { get; set; }Output only. The result of a data profile scan.
| Property Value | |
|---|---|
| Type | Description |
DataProfileResult |
|
DataProfileSpec
public DataProfileSpec DataProfileSpec { get; set; }Settings for a data profile scan.
| Property Value | |
|---|---|
| Type | Description |
DataProfileSpec |
|
DataQualityResult
public DataQualityResult DataQualityResult { get; set; }Output only. The result of a data quality scan.
| Property Value | |
|---|---|
| Type | Description |
DataQualityResult |
|
DataQualitySpec
public DataQualitySpec DataQualitySpec { get; set; }Settings for a data quality scan.
| Property Value | |
|---|---|
| Type | Description |
DataQualitySpec |
|
DataScanName
public DataScanName DataScanName { get; set; }DataScanName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
DataScanName |
|
Description
public string Description { get; set; }Optional. Description of the scan.
- Must be between 1-1024 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Optional. User friendly display name.
- Must be between 1-256 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ExecutionIdentity
public ExecutionIdentity ExecutionIdentity { get; set; }Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent.
| Property Value | |
|---|---|
| Type | Description |
ExecutionIdentity |
|
ExecutionSpec
public DataScan.Types.ExecutionSpec ExecutionSpec { get; set; }Optional. DataScan execution settings.
If not specified, the fields in it will use their default values.
| Property Value | |
|---|---|
| Type | Description |
DataScanTypesExecutionSpec |
|
ExecutionStatus
public DataScan.Types.ExecutionStatus ExecutionStatus { get; set; }Output only. Status of the data scan execution.
| Property Value | |
|---|---|
| Type | Description |
DataScanTypesExecutionStatus |
|
Labels
public MapField<string, string> Labels { get; }Optional. User-defined labels for the scan.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ResultCase
public DataScan.ResultOneofCase ResultCase { get; }| Property Value | |
|---|---|
| Type | Description |
DataScanResultOneofCase |
|
SpecCase
public DataScan.SpecOneofCase SpecCase { get; }| Property Value | |
|---|---|
| Type | Description |
DataScanSpecOneofCase |
|
State
public State State { get; set; }Output only. Current state of the DataScan.
| Property Value | |
|---|---|
| Type | Description |
State |
|
Type
public DataScanType Type { get; set; }Output only. The type of DataScan.
| Property Value | |
|---|---|
| Type | Description |
DataScanType |
|
Uid
public string Uid { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The time when the scan was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|