Package com.oracle.bmc.datasafe.model

Class CreateSensitiveColumnDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class CreateSensitiveColumnDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details to create a new sensitive column in a sensitive data model.
    Note: Objects should always be created or deserialized using the CreateSensitiveColumnDetails.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 CreateSensitiveColumnDetails.Builder, which maintain a set of all explicitly set fields called CreateSensitiveColumnDetails.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

      • getAppName

        public String getAppName()
        The name of the application associated with the sensitive column.

        It’s useful when the application name is different from the schema name. Otherwise, it can be ignored. If this attribute is not provided, it’s automatically populated with the value provided for the schemaName attribute.

        Returns:
        the value

      • getSchemaName

        public String getSchemaName()
        The database schema that contains the sensitive column.
        Returns:
        the value

      • getObjectName

        public String getObjectName()
        The database object that contains the sensitive column.
        Returns:
        the value

      • getColumnName

        public String getColumnName()
        The name of the sensitive column.
        Returns:
        the value

      • getDataType

        public String getDataType()
        The data type of the sensitive column.
        Returns:
        the value

      • getStatus

        public CreateSensitiveColumnDetails.Status getStatus()
        The status of the sensitive column.

        VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive.

        Returns:
        the value

      • getSensitiveTypeId

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

      • getParentColumnKeys

        public List<String> getParentColumnKeys()
        Unique keys identifying the columns that are parents of the sensitive column.

        At present, it accepts only one parent column key. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the parent column must be added to the sensitive data model before its key can be specified here. If this attribute is provided, the appDefinedChildColumnKeys or dbDefinedChildColumnKeys attribute of the parent column is automatically updated to reflect the relationship.

        Returns:
        the value

      • getRelationType

        public CreateSensitiveColumnDetails.RelationType getRelationType()
        The type of referential relationship the sensitive column has with its parent.

        NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

        Returns:
        the value

      • getAppDefinedChildColumnKeys

        public List<String> getAppDefinedChildColumnKeys()
        Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

        This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

        Returns:
        the value

      • getDbDefinedChildColumnKeys

        public List<String> getDbDefinedChildColumnKeys()
        Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

        This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

        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