java.lang.Object
- com.azure.core.management.ProxyResource
- - com.azure.resourcemanager.synapse.fluent.models.DataMaskingRuleInner

public final class DataMaskingRuleInner
extends com.azure.core.management.ProxyResource

Represents a Sql pool data masking rule.

Constructor Summary

Constructors
Constructor Description

DataMaskingRuleInner()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`aliasName()`	Get the aliasName property: The alias name.
`String`	`columnName()`	Get the columnName property: The column name on which the data masking rule is applied.
`String`	`idPropertiesId()`	Get the id property: The rule Id.
`String`	`kind()`	Get the kind property: The kind of Data Masking Rule.
`String`	`location()`	Get the location property: The location of the data masking rule.
`DataMaskingFunction`	`maskingFunction()`	Get the maskingFunction property: The masking function that is used for the data masking rule.
`String`	`numberFrom()`	Get the numberFrom property: The numberFrom property of the masking rule.
`String`	`numberTo()`	Get the numberTo property: The numberTo property of the data masking rule.
`String`	`prefixSize()`	Get the prefixSize property: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string.
`String`	`replacementString()`	Get the replacementString property: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string.
`DataMaskingRuleState`	`ruleState()`	Get the ruleState property: The rule state.
`String`	`schemaName()`	Get the schemaName property: The schema name on which the data masking rule is applied.
`String`	`suffixSize()`	Get the suffixSize property: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string.
`String`	`tableName()`	Get the tableName property: The table name on which the data masking rule is applied.
`void`	`validate()`	Validates the instance.
`DataMaskingRuleInner`	`withAliasName(String aliasName)`	Set the aliasName property: The alias name.
`DataMaskingRuleInner`	`withColumnName(String columnName)`	Set the columnName property: The column name on which the data masking rule is applied.
`DataMaskingRuleInner`	`withMaskingFunction(DataMaskingFunction maskingFunction)`	Set the maskingFunction property: The masking function that is used for the data masking rule.
`DataMaskingRuleInner`	`withNumberFrom(String numberFrom)`	Set the numberFrom property: The numberFrom property of the masking rule.
`DataMaskingRuleInner`	`withNumberTo(String numberTo)`	Set the numberTo property: The numberTo property of the data masking rule.
`DataMaskingRuleInner`	`withPrefixSize(String prefixSize)`	Set the prefixSize property: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string.
`DataMaskingRuleInner`	`withReplacementString(String replacementString)`	Set the replacementString property: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string.
`DataMaskingRuleInner`	`withRuleState(DataMaskingRuleState ruleState)`	Set the ruleState property: The rule state.
`DataMaskingRuleInner`	`withSchemaName(String schemaName)`	Set the schemaName property: The schema name on which the data masking rule is applied.
`DataMaskingRuleInner`	`withSuffixSize(String suffixSize)`	Set the suffixSize property: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string.
`DataMaskingRuleInner`	`withTableName(String tableName)`	Set the tableName property: The table name on which the data masking rule is applied.

Methods inherited from class com.azure.core.management.ProxyResource
id, name, type

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DataMaskingRuleInner
```
public DataMaskingRuleInner()
```
- Method Detail
  - location
```
public String location()
```
    Get the location property: The location of the data masking rule.
    
    Returns:
    
    the location value.
  - kind
```
public String kind()
```
    Get the kind property: The kind of Data Masking Rule. Metadata, used for Azure portal.
    
    Returns:
    
    the kind value.
  - idPropertiesId
```
public String idPropertiesId()
```
    Get the id property: The rule Id.
    
    Returns:
    
    the id value.
  - aliasName
```
public String aliasName()
```
    Get the aliasName property: The alias name. This is a legacy parameter and is no longer used.
    
    Returns:
    
    the aliasName value.
  - withAliasName
```
public DataMaskingRuleInner withAliasName(String aliasName)
```
    Set the aliasName property: The alias name. This is a legacy parameter and is no longer used.
    
    Parameters:
    
    aliasName - the aliasName value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - ruleState
```
public DataMaskingRuleState ruleState()
```
    Get the ruleState property: The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.
    
    Returns:
    
    the ruleState value.
  - withRuleState
```
public DataMaskingRuleInner withRuleState(DataMaskingRuleState ruleState)
```
    Set the ruleState property: The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.
    
    Parameters:
    
    ruleState - the ruleState value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - schemaName
```
public String schemaName()
```
    Get the schemaName property: The schema name on which the data masking rule is applied.
    
    Returns:
    
    the schemaName value.
  - withSchemaName
```
public DataMaskingRuleInner withSchemaName(String schemaName)
```
    Set the schemaName property: The schema name on which the data masking rule is applied.
    
    Parameters:
    
    schemaName - the schemaName value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - tableName
```
public String tableName()
```
    Get the tableName property: The table name on which the data masking rule is applied.
    
    Returns:
    
    the tableName value.
  - withTableName
```
public DataMaskingRuleInner withTableName(String tableName)
```
    Set the tableName property: The table name on which the data masking rule is applied.
    
    Parameters:
    
    tableName - the tableName value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - columnName
```
public String columnName()
```
    Get the columnName property: The column name on which the data masking rule is applied.
    
    Returns:
    
    the columnName value.
  - withColumnName
```
public DataMaskingRuleInner withColumnName(String columnName)
```
    Set the columnName property: The column name on which the data masking rule is applied.
    
    Parameters:
    
    columnName - the columnName value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - maskingFunction
```
public DataMaskingFunction maskingFunction()
```
    Get the maskingFunction property: The masking function that is used for the data masking rule.
    
    Returns:
    
    the maskingFunction value.
  - withMaskingFunction
```
public DataMaskingRuleInner withMaskingFunction(DataMaskingFunction maskingFunction)
```
    Set the maskingFunction property: The masking function that is used for the data masking rule.
    
    Parameters:
    
    maskingFunction - the maskingFunction value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - numberFrom
```
public String numberFrom()
```
    Get the numberFrom property: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
    
    Returns:
    
    the numberFrom value.
  - withNumberFrom
```
public DataMaskingRuleInner withNumberFrom(String numberFrom)
```
    Set the numberFrom property: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
    
    Parameters:
    
    numberFrom - the numberFrom value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - numberTo
```
public String numberTo()
```
    Get the numberTo property: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
    
    Returns:
    
    the numberTo value.
  - withNumberTo
```
public DataMaskingRuleInner withNumberTo(String numberTo)
```
    Set the numberTo property: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
    
    Parameters:
    
    numberTo - the numberTo value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - prefixSize
```
public String prefixSize()
```
    Get the prefixSize property: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.
    
    Returns:
    
    the prefixSize value.
  - withPrefixSize
```
public DataMaskingRuleInner withPrefixSize(String prefixSize)
```
    Set the prefixSize property: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.
    
    Parameters:
    
    prefixSize - the prefixSize value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - suffixSize
```
public String suffixSize()
```
    Get the suffixSize property: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.
    
    Returns:
    
    the suffixSize value.
  - withSuffixSize
```
public DataMaskingRuleInner withSuffixSize(String suffixSize)
```
    Set the suffixSize property: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.
    
    Parameters:
    
    suffixSize - the suffixSize value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - replacementString
```
public String replacementString()
```
    Get the replacementString property: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.
    
    Returns:
    
    the replacementString value.
  - withReplacementString
```
public DataMaskingRuleInner withReplacementString(String replacementString)
```
    Set the replacementString property: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.
    
    Parameters:
    
    replacementString - the replacementString value to set.
    
    Returns:
    
    the DataMaskingRuleInner object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Class DataMaskingRuleInner

Constructor Summary

Method Summary

Methods inherited from class com.azure.core.management.ProxyResource

Methods inherited from class java.lang.Object

Constructor Detail

DataMaskingRuleInner

Method Detail

location

kind

idPropertiesId

aliasName

withAliasName

ruleState

withRuleState

schemaName

withSchemaName

tableName

withTableName

columnName

withColumnName

maskingFunction

withMaskingFunction

numberFrom

withNumberFrom

numberTo

withNumberTo

prefixSize

withPrefixSize

suffixSize

withSuffixSize

replacementString

withReplacementString

validate