Rule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.gluedatabrew.model.Rule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Rule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a single data quality requirement that should be validated in the scope of this dataset.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Rule()

Constructors
Constructor and Description
`Rule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Rule`	`addSubstitutionMapEntry(String key, String value)` Add a single SubstitutionMap entry
`Rule`	`clearSubstitutionMapEntries()` Removes all the entries added into SubstitutionMap.
`Rule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCheckExpression()` The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.
`List<ColumnSelector>`	`getColumnSelectors()` List of column selectors.
`Boolean`	`getDisabled()` A value that specifies whether the rule is disabled.
`String`	`getName()` The name of the rule.
`Map<String,String>`	`getSubstitutionMap()` The map of substitution variable names to their values used in a check expression.
`Threshold`	`getThreshold()` The threshold used with a non-aggregate check expression.
`int`	`hashCode()`
`Boolean`	`isDisabled()` A value that specifies whether the rule is disabled.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCheckExpression(String checkExpression)` The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.
`void`	`setColumnSelectors(Collection<ColumnSelector> columnSelectors)` List of column selectors.
`void`	`setDisabled(Boolean disabled)` A value that specifies whether the rule is disabled.
`void`	`setName(String name)` The name of the rule.
`void`	`setSubstitutionMap(Map<String,String> substitutionMap)` The map of substitution variable names to their values used in a check expression.
`void`	`setThreshold(Threshold threshold)` The threshold used with a non-aggregate check expression.
`String`	`toString()` Returns a string representation of this object.
`Rule`	`withCheckExpression(String checkExpression)` The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions.
`Rule`	`withColumnSelectors(Collection<ColumnSelector> columnSelectors)` List of column selectors.
`Rule`	`withColumnSelectors(ColumnSelector... columnSelectors)` List of column selectors.
`Rule`	`withDisabled(Boolean disabled)` A value that specifies whether the rule is disabled.
`Rule`	`withName(String name)` The name of the rule.
`Rule`	`withSubstitutionMap(Map<String,String> substitutionMap)` The map of substitution variable names to their values used in a check expression.
`Rule`	`withThreshold(Threshold threshold)` The threshold used with a non-aggregate check expression.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Rule
```
public Rule()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
  - getName
```
public String getName()
```
    The name of the rule.
    
    Returns:
    
    The name of the rule.
  - withName
```
public Rule withName(String name)
```
    The name of the rule.
    
    Parameters:
    
    name - The name of the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisabled
```
public void setDisabled(Boolean 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.
    
    Parameters:
    
    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.
  - getDisabled
```
public Boolean getDisabled()
```
    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.
    
    Returns:
    
    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.
  - withDisabled
```
public Rule withDisabled(Boolean 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDisabled
```
public Boolean isDisabled()
```
    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.
    
    Returns:
    
    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.
  - setCheckExpression
```
public void setCheckExpression(String 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
    
    Parameters:
    
    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
  - getCheckExpression
```
public String getCheckExpression()
```
    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
    
    Returns:
    
    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
  - withCheckExpression
```
public Rule withCheckExpression(String 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
    
    Parameters:
    
    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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubstitutionMap
```
public Map<String,String> getSubstitutionMap()
```
    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`".
    
    Returns:
    
    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`".
  - setSubstitutionMap
```
public void setSubstitutionMap(Map<String,String> 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`".
    
    Parameters:
    
    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`".
  - withSubstitutionMap
```
public Rule withSubstitutionMap(Map<String,String> 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`".
    
    Parameters:
    
    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`".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addSubstitutionMapEntry
```
public Rule addSubstitutionMapEntry(String key,
                                    String value)
```
    Add a single SubstitutionMap entry
    
    See Also:
    
    withSubstitutionMap(java.util.Map<java.lang.String, java.lang.String>)
  - clearSubstitutionMapEntries
```
public Rule clearSubstitutionMapEntries()
```
    Removes all the entries added into SubstitutionMap.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThreshold
```
public void setThreshold(Threshold 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.
    
    Parameters:
    
    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.
  - getThreshold
```
public Threshold getThreshold()
```
    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.
    
    Returns:
    
    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.
  - withThreshold
```
public Rule withThreshold(Threshold 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getColumnSelectors
```
public List<ColumnSelector> getColumnSelectors()
```
    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.
    
    Returns:
    
    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.
  - setColumnSelectors
```
public void setColumnSelectors(Collection<ColumnSelector> 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.
    
    Parameters:
    
    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.
  - withColumnSelectors
```
public Rule withColumnSelectors(ColumnSelector... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setColumnSelectors(java.util.Collection) or withColumnSelectors(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withColumnSelectors
```
public Rule withColumnSelectors(Collection<ColumnSelector> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Rule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.771

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

setName

getName

withName

setDisabled

getDisabled

withDisabled

isDisabled

setCheckExpression

getCheckExpression

withCheckExpression

getSubstitutionMap

setSubstitutionMap

withSubstitutionMap

addSubstitutionMapEntry

clearSubstitutionMapEntries

setThreshold

getThreshold

withThreshold

getColumnSelectors

setColumnSelectors

withColumnSelectors

withColumnSelectors

toString

equals

hashCode

clone

marshall