Package com.hashicorp.cdktf.providers.google.dataplex_datascan

Interface DataplexDatascanDataQualitySpecRules

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    DataplexDatascanDataQualitySpecRules.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:20.596Z")
@Stability(Stable)
public interface DataplexDatascanDataQualitySpecRules
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getDimension

        @Stability(Stable)
@NotNull
String getDimension()
        The dimension a rule belongs to.

        Results are also aggregated at the dimension level. Supported dimensions are ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#dimension DataplexDatascan#dimension}

      • getColumn

        @Stability(Stable)
@Nullable
default String getColumn()
        The unnested column which this rule is evaluated against.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#column DataplexDatascan#column}

      • getDescription

        @Stability(Stable)
@Nullable
default String getDescription()
        Description of the rule. The maximum length is 1,024 characters.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#description DataplexDatascan#description}

      • getIgnoreNull

        @Stability(Stable)
@Nullable
default Object getIgnoreNull()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#ignore_null DataplexDatascan#ignore_null}

      • getName

        @Stability(Stable)
@Nullable
default String getName()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#name DataplexDatascan#name}

      • getNonNullExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesNonNullExpectation getNonNullExpectation()
        non_null_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#non_null_expectation DataplexDatascan#non_null_expectation}

      • getRangeExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesRangeExpectation getRangeExpectation()
        range_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#range_expectation DataplexDatascan#range_expectation}

      • getRegexExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesRegexExpectation getRegexExpectation()
        regex_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#regex_expectation DataplexDatascan#regex_expectation}

      • getRowConditionExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesRowConditionExpectation getRowConditionExpectation()
        row_condition_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#row_condition_expectation DataplexDatascan#row_condition_expectation}

      • getSetExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesSetExpectation getSetExpectation()
        set_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#set_expectation DataplexDatascan#set_expectation}

      • getSqlAssertion

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesSqlAssertion getSqlAssertion()
        sql_assertion block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#sql_assertion DataplexDatascan#sql_assertion}

      • getStatisticRangeExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesStatisticRangeExpectation getStatisticRangeExpectation()
        statistic_range_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#statistic_range_expectation DataplexDatascan#statistic_range_expectation}

      • getTableConditionExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesTableConditionExpectation getTableConditionExpectation()
        table_condition_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#table_condition_expectation DataplexDatascan#table_condition_expectation}

      • getThreshold

        @Stability(Stable)
@Nullable
default Number getThreshold()
        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).

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#threshold DataplexDatascan#threshold}

      • getUniquenessExpectation

        @Stability(Stable)
@Nullable
default DataplexDatascanDataQualitySpecRulesUniquenessExpectation getUniquenessExpectation()
        uniqueness_expectation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_datascan#uniqueness_expectation DataplexDatascan#uniqueness_expectation}