AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents a single data quality requirement that should be validated in the scope of this dataset.

Inheritance Hierarchy

System.Object
  Amazon.GlueDataBrew.Model.Rule

Namespace: Amazon.GlueDataBrew.Model
Assembly: AWSSDK.GlueDataBrew.dll
Version: 3.x.y.z

Syntax

C#
public class Rule

The Rule type exposes the following members

Constructors

NameDescription
Public Method Rule()

Properties

NameTypeDescription
Public Property CheckExpression System.String

Gets and sets the property CheckExpression.

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

Public Property ColumnSelectors System.Collections.Generic.List<Amazon.GlueDataBrew.Model.ColumnSelector>

Gets and sets the property ColumnSelectors.

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.

Public Property Disabled System.Boolean

Gets and sets the property Disabled.

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.

Public Property Name System.String

Gets and sets the property Name.

The name of the rule.

Public Property SubstitutionMap System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property SubstitutionMap.

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`".

Public Property Threshold Amazon.GlueDataBrew.Model.Threshold

Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5