Class 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).

Inheritance
object
GoogleCloudDataplexV1DataScan
Implements
Inherited Members
Namespace: Google.Apis.CloudDataplex.v1.Data
Assembly: Google.Apis.CloudDataplex.v1.dll
Syntax
public class GoogleCloudDataplexV1DataScan : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. The time when the scan was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Data

Required. The data source for DataScan.

Declaration
[JsonProperty("data")]
public virtual GoogleCloudDataplexV1DataSource Data { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataSource

DataDiscoveryResult

Output only. The result of a data discovery scan.

Declaration
[JsonProperty("dataDiscoveryResult")]
public virtual GoogleCloudDataplexV1DataDiscoveryResult DataDiscoveryResult { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataDiscoveryResult

DataDiscoverySpec

Settings for a data discovery scan.

Declaration
[JsonProperty("dataDiscoverySpec")]
public virtual GoogleCloudDataplexV1DataDiscoverySpec DataDiscoverySpec { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataDiscoverySpec

DataDocumentationResult

Output only. The result of a data documentation scan.

Declaration
[JsonProperty("dataDocumentationResult")]
public virtual GoogleCloudDataplexV1DataDocumentationResult DataDocumentationResult { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataDocumentationResult

DataDocumentationSpec

Settings for a data documentation scan.

Declaration
[JsonProperty("dataDocumentationSpec")]
public virtual GoogleCloudDataplexV1DataDocumentationSpec DataDocumentationSpec { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataDocumentationSpec

DataProfileResult

Output only. The result of a data profile scan.

Declaration
[JsonProperty("dataProfileResult")]
public virtual GoogleCloudDataplexV1DataProfileResult DataProfileResult { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataProfileResult

DataProfileSpec

Settings for a data profile scan.

Declaration
[JsonProperty("dataProfileSpec")]
public virtual GoogleCloudDataplexV1DataProfileSpec DataProfileSpec { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataProfileSpec

DataQualityResult

Output only. The result of a data quality scan.

Declaration
[JsonProperty("dataQualityResult")]
public virtual GoogleCloudDataplexV1DataQualityResult DataQualityResult { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualityResult

DataQualitySpec

Settings for a data quality scan.

Declaration
[JsonProperty("dataQualitySpec")]
public virtual GoogleCloudDataplexV1DataQualitySpec DataQualitySpec { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataQualitySpec

Description

Optional. Description of the scan. Must be between 1-1024 characters.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

DisplayName

Optional. User friendly display name. Must be between 1-256 characters.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExecutionIdentity

Optional. Immutable. The identity to run the datascan. If not specified, defaults to the Dataplex Service Agent.

Declaration
[JsonProperty("executionIdentity")]
public virtual GoogleCloudDataplexV1ExecutionIdentity ExecutionIdentity { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1ExecutionIdentity

ExecutionSpec

Optional. DataScan execution settings.If not specified, the fields in it will use their default values.

Declaration
[JsonProperty("executionSpec")]
public virtual GoogleCloudDataplexV1DataScanExecutionSpec ExecutionSpec { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataScanExecutionSpec

ExecutionStatus

Output only. Status of the data scan execution.

Declaration
[JsonProperty("executionStatus")]
public virtual GoogleCloudDataplexV1DataScanExecutionStatus ExecutionStatus { get; set; }
Property Value
Type Description
GoogleCloudDataplexV1DataScanExecutionStatus

Labels

Optional. User-defined labels for the scan.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

State

Output only. Current state of the DataScan.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

Type

Output only. The type of DataScan.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Uid

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.

Declaration
[JsonProperty("uid")]
public virtual string Uid { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. The time when the scan was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements