Package com.azure.resourcemanager.synapse.fluent.models

Class DataMaskingRuleProperties

java.lang.Object
com.azure.resourcemanager.synapse.fluent.models.DataMaskingRuleProperties
public final class DataMaskingRuleProperties extends Object
The properties of a Sql pool data masking rule.

  • Constructor Details

    • DataMaskingRuleProperties

      public DataMaskingRuleProperties()
      Creates an instance of DataMaskingRuleProperties class.

  • Method Details

    • id

      public String id()
      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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties 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 DataMaskingRuleProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.