Cloud Dataplex v1 API - Class DataProfileSpec (2.5.0)

public sealed class DataProfileSpec : IMessage<DataProfileSpec>, IEquatable<DataProfileSpec>, IDeepCloneable<DataProfileSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class DataProfileSpec.

DataProfileScan related setting.

Inheritance

object > DataProfileSpec

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

DataProfileSpec()

public DataProfileSpec()

DataProfileSpec(DataProfileSpec)

public DataProfileSpec(DataProfileSpec other)
Parameter
NameDescription
otherDataProfileSpec

Properties

ExcludeFields

public DataProfileSpec.Types.SelectedFields ExcludeFields { get; set; }

Optional. The fields to exclude from data profile.

If specified, the fields will be excluded from data profile, regardless of include_fields value.

Property Value
TypeDescription
DataProfileSpecTypesSelectedFields

IncludeFields

public DataProfileSpec.Types.SelectedFields IncludeFields { get; set; }

Optional. The fields to include in data profile.

If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields.

Property Value
TypeDescription
DataProfileSpecTypesSelectedFields

PostScanActions

public DataProfileSpec.Types.PostScanActions PostScanActions { get; set; }

Optional. Actions to take upon job completion..

Property Value
TypeDescription
DataProfileSpecTypesPostScanActions

RowFilter

public string RowFilter { get; set; }

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

Property Value
TypeDescription
string

SamplingPercent

public float SamplingPercent { get; set; }

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.
Property Value
TypeDescription
float