Package com.oracle.bmc.datasafe.model

Class CreateMaskingColumnDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class CreateMaskingColumnDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details to create a new masking column.

    You can use this to add a parent column only. It automatically adds the child columns from the associated sensitive data model or target database. If you provide the sensitiveTypeId attribute but not the maskingFormats attribute, it automatically assigns the default masking format associated with the specified sensitive type. Alternatively, if you provide the maskingFormats attribute, the specified masking formats are assigned to the column.

    Using the maskingFormats attribute, you can assign one or more masking formats to a column. You can specify a condition as part of each masking format. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.

    You can use the maskingColumnGroup attribute to group the columns that you would like to mask together. It enables you to do group or compound masking that ensures that the masked data across the columns in a group continue to retain the same logical relationship.
    Note: Objects should always be created or deserialized using the CreateMaskingColumnDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CreateMaskingColumnDetails.Builder, which maintain a set of all explicitly set fields called CreateMaskingColumnDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getSchemaName

        public String getSchemaName()
        The name of the schema that contains the database column.

        This attribute cannot be updated for an existing masking column.

        Returns:
        the value

      • getObjectName

        public String getObjectName()
        The name of the object (table or editioning view) that contains the database column.

        This attribute cannot be updated for an existing masking column.

        Returns:
        the value

      • getObjectType

        public ObjectType getObjectType()
        The type of the object that contains the database column.
        Returns:
        the value

      • getColumnName

        public String getColumnName()
        The name of the database column.

        This attribute cannot be updated for an existing masking column. Note that the same name is used for the masking column. There is no separate displayName attribute for the masking column.

        Returns:
        the value

      • getMaskingColumnGroup

        public String getMaskingColumnGroup()
        The group of the masking column.

        It’s a masking group identifier and can be any string of acceptable length. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check Group Masking in the Data Safe documentation.

        Returns:
        the value

      • getSensitiveTypeId

        public String getSensitiveTypeId()
        The OCID of the sensitive type to be associated with the masking column.

        Note that if the maskingFormats attribute isn’t provided while creating a masking column, the default masking format associated with the specified sensitive type is assigned to the masking column.

        Returns:
        the value

      • getIsMaskingEnabled

        public Boolean getIsMaskingEnabled()
        Indicates whether data masking is enabled for the masking column.

        Set it to false if you don’t want to mask the column.

        Returns:
        the value

      • getMaskingFormats

        public List<MaskingFormat> getMaskingFormats()
        The masking formats to be assigned to the masking column.

        You can specify a condition as part of each masking format. It enables you to do conditional masking so that you can mask the column data values differently using different masking formats and the associated conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel