pulumi-gcp-kotlin/com.pulumi.gcp.dataplex.kotlin.outputs/DatascanDataQualitySpecRule

DatascanDataQualitySpecRule

data class DatascanDataQualitySpecRule(val column: String? = null, val description: String? = null, val dimension: String, val ignoreNull: Boolean? = null, val name: String? = null, val nonNullExpectation: DatascanDataQualitySpecRuleNonNullExpectation? = null, val rangeExpectation: DatascanDataQualitySpecRuleRangeExpectation? = null, val regexExpectation: DatascanDataQualitySpecRuleRegexExpectation? = null, val rowConditionExpectation: DatascanDataQualitySpecRuleRowConditionExpectation? = null, val setExpectation: DatascanDataQualitySpecRuleSetExpectation? = null, val statisticRangeExpectation: DatascanDataQualitySpecRuleStatisticRangeExpectation? = null, val tableConditionExpectation: DatascanDataQualitySpecRuleTableConditionExpectation? = null, val threshold: Double? = null, val uniquenessExpectation: DatascanDataQualitySpecRuleUniquenessExpectation? = null)

Constructors

Link copied to clipboard
fun DatascanDataQualitySpecRule(column: String? = null, description: String? = null, dimension: String, ignoreNull: Boolean? = null, name: String? = null, nonNullExpectation: DatascanDataQualitySpecRuleNonNullExpectation? = null, rangeExpectation: DatascanDataQualitySpecRuleRangeExpectation? = null, regexExpectation: DatascanDataQualitySpecRuleRegexExpectation? = null, rowConditionExpectation: DatascanDataQualitySpecRuleRowConditionExpectation? = null, setExpectation: DatascanDataQualitySpecRuleSetExpectation? = null, statisticRangeExpectation: DatascanDataQualitySpecRuleStatisticRangeExpectation? = null, tableConditionExpectation: DatascanDataQualitySpecRuleTableConditionExpectation? = null, threshold: Double? = null, uniquenessExpectation: DatascanDataQualitySpecRuleUniquenessExpectation? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val column: String? = null

The unnested column which this rule is evaluated against.

Link copied to clipboard
val description: String? = null

Description of the rule. The maximum length is 1,024 characters.

Link copied to clipboard
val dimension: String

The dimension a rule belongs to. Results are also aggregated at the dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"

Link copied to clipboard
val ignoreNull: Boolean? = null

Rows with null values will automatically fail a rule, unless ignoreNull is true. In that case, such null rows are trivially considered passing. Only applicable to ColumnMap rules.

Link copied to clipboard
val name: String? = null

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.

Link copied to clipboard
val nonNullExpectation: DatascanDataQualitySpecRuleNonNullExpectation? = null

ColumnMap rule which evaluates whether each column value is null.

Link copied to clipboard
val rangeExpectation: DatascanDataQualitySpecRuleRangeExpectation? = null

ColumnMap rule which evaluates whether each column value lies between a specified range. Structure is documented below.

Link copied to clipboard
val regexExpectation: DatascanDataQualitySpecRuleRegexExpectation? = null

ColumnMap rule which evaluates whether each column value matches a specified regex. Structure is documented below.

Link copied to clipboard
val rowConditionExpectation: DatascanDataQualitySpecRuleRowConditionExpectation? = null

Table rule which evaluates whether each row passes the specified condition. Structure is documented below.

Link copied to clipboard
val setExpectation: DatascanDataQualitySpecRuleSetExpectation? = null

ColumnMap rule which evaluates whether each column value is contained by a specified set. Structure is documented below.

Link copied to clipboard
val statisticRangeExpectation: DatascanDataQualitySpecRuleStatisticRangeExpectation? = null

ColumnAggregate rule which evaluates whether the column aggregate statistic lies between a specified range. Structure is documented below.

Link copied to clipboard
val tableConditionExpectation: DatascanDataQualitySpecRuleTableConditionExpectation? = null

Table rule which evaluates whether the provided expression is true. Structure is documented below.

Link copied to clipboard
val threshold: Double? = null

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

Link copied to clipboard
val uniquenessExpectation: DatascanDataQualitySpecRuleUniquenessExpectation? = null

Row-level rule which evaluates whether each column value is unique.