Share via

DataMaskingRuleInner Class

  • Reference
Package:
com.azure.resourcemanager.sql.fluent.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-sql:2.44.0

public final class DataMaskingRuleInner
extends ProxyResource

A database data masking rule.

Constructor Summary

Constructor Description
DataMaskingRuleInner()

Creates an instance of DataMaskingRuleInner class.

Method Summary

Modifier and Type Method and 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.
static DataMaskingRuleInner fromJson(JsonReader jsonReader)

Reads an instance of DataMaskingRuleInner from the JsonReader.
String id()

Get the id property: Fully qualified resource Id for the resource.
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 name()

Get the name property: The name of the resource.
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.
JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.
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 ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataMaskingRuleInner

public DataMaskingRuleInner()

Creates an instance of DataMaskingRuleInner class.

Method Details

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.

columnName

public String columnName()

Get the columnName property: The column name on which the data masking rule is applied.

Returns:

the columnName value.

fromJson

public static DataMaskingRuleInner fromJson(JsonReader jsonReader)

Reads an instance of DataMaskingRuleInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DataMaskingRuleInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

DataMaskingRuleInner.id()

Returns:

the id value.

idPropertiesId

public String idPropertiesId()

Get the id property: The rule Id.

Returns:

the id value.

kind

public String kind()

Get the kind property: The kind of Data Masking Rule. Metadata, used for Azure portal.

Returns:

the kind value.

location

public String location()

Get the location property: The location of the data masking rule.

Returns:

the location value.

maskingFunction

public DataMaskingFunction maskingFunction()

Get the maskingFunction property: The masking function that is used for the data masking rule.

Returns:

the maskingFunction value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

DataMaskingRuleInner.name()

Returns:

the name value.

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.

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.

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.

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.

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.

schemaName

public String schemaName()

Get the schemaName property: The schema name on which the data masking rule is applied.

Returns:

the schemaName value.

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.

tableName

public String tableName()

Get the tableName property: The table name on which the data masking rule is applied.

Returns:

the tableName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

DataMaskingRuleInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

DataMaskingRuleInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Applies to