Struct RuleBuilder

#[non_exhaustive]
pub struct RuleBuilder { /* private fields */ }

A builder for Rule.

Implementations

impl RuleBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of the rule.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the rule.

pub fn get_name(&self) -> &Option<String>

The name of the rule.

pub fn disabled(self, input: bool) -> Self

A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

pub fn set_disabled(self, input: Option<bool>) -> Self

A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

pub fn get_disabled(&self) -> &Option<bool>

A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

pub fn check_expression(self, input: impl Into<String>) -> Self

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

For more information, see Available checks

This field is required.

pub fn set_check_expression(self, input: Option<String>) -> Self

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

For more information, see Available checks

pub fn get_check_expression(&self) -> &Option<String>

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no column reference in the left side of a condition, for example, is_between :val1 and :val2.

For more information, see Available checks

pub fn substitution_map( self, k: impl Into<String>, v: impl Into<String>, ) -> Self

Adds a key-value pair to substitution_map.

To override the contents of this collection use set_substitution_map.

The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "`Column A`".

pub fn set_substitution_map( self, input: Option<HashMap<String, String>>, ) -> Self

The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "`Column A`".

pub fn get_substitution_map(&self) -> &Option<HashMap<String, String>>

The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, ":col1": "`Column A`".

pub fn threshold(self, input: Threshold) -> Self

The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

pub fn set_threshold(self, input: Option<Threshold>) -> Self

The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

pub fn get_threshold(&self) -> &Option<Threshold>

The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

pub fn column_selectors(self, input: ColumnSelector) -> Self

Appends an item to column_selectors.

To override the contents of this collection use set_column_selectors.

List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

pub fn set_column_selectors(self, input: Option<Vec<ColumnSelector>>) -> Self

List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

pub fn get_column_selectors(&self) -> &Option<Vec<ColumnSelector>>

List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

pub fn build(self) -> Result<Rule, BuildError>

Consumes the builder and constructs a Rule. This method will fail if any of the following fields are not set:

• name
• check_expression

Trait Implementations

impl Clone for RuleBuilder

fn clone(&self) -> RuleBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RuleBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RuleBuilder

fn default() -> RuleBuilder

Returns the “default value” for a type.

impl PartialEq for RuleBuilder

fn eq(&self, other: &RuleBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RuleBuilder