/** * Data Safe API * APIs for using Oracle Data Safe. * OpenAPI spec version: 20181201 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * 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. * */ export interface CreateMaskingColumnDetails { /** * The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column. */ "schemaName": string; /** * The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column. */ "objectName": string; /** * The type of the object that contains the database column. */ "objectType"?: model.ObjectType; /** * 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. * */ "columnName": string; /** * 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. * */ "maskingColumnGroup"?: string; /** * 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. * */ "sensitiveTypeId"?: string; /** * Indicates whether data masking is enabled for the masking column. Set it to false if * you don't want to mask the column. * */ "isMaskingEnabled"?: boolean; /** * 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. * */ "maskingFormats"?: Array; } export declare namespace CreateMaskingColumnDetails { function getJsonObj(obj: CreateMaskingColumnDetails): object; function getDeserializedJsonObj(obj: CreateMaskingColumnDetails): object; }