Package com.oracle.bmc.datasafe.model

Class SensitiveDataModel.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public SensitiveDataModel.Builder displayName​(String displayName)
        The display name of the sensitive data model.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • compartmentId

        public SensitiveDataModel.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the sensitive data model.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • targetId

        public SensitiveDataModel.Builder targetId​(String targetId)
        The OCID of the reference target database associated with the sensitive data model.

        All operations such as performing data discovery and adding columns manually are done in the context of the associated target database.

        Parameters:
        targetId - the value to set
        Returns:
        this builder

      • timeCreated

        public SensitiveDataModel.Builder timeCreated​(Date timeCreated)
        The date and time the sensitive data model was created, in the format defined by RFC3339.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public SensitiveDataModel.Builder timeUpdated​(Date timeUpdated)
        The date and time the sensitive data model was last updated, in the format defined by RFC3339.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • appSuiteName

        public SensitiveDataModel.Builder appSuiteName​(String appSuiteName)
        The application suite name identifying a collection of applications.

        The default value is GENERIC. It’s useful only if maintaining a sensitive data model for a suite of applications.

        Parameters:
        appSuiteName - the value to set
        Returns:
        this builder

      • description

        public SensitiveDataModel.Builder description​(String description)
        The description of the sensitive data model.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • schemasForDiscovery

        public SensitiveDataModel.Builder schemasForDiscovery​(List<String> schemasForDiscovery)
        The schemas to be scanned by data discovery jobs.
        Parameters:
        schemasForDiscovery - the value to set
        Returns:
        this builder

      • tablesForDiscovery

        public SensitiveDataModel.Builder tablesForDiscovery​(List<TablesForDiscovery> tablesForDiscovery)
        The data discovery jobs will scan the tables specified here, including both schemas and tables.

        For instance, the input could be in the format: [{schemaName: “HR”, tableName: [“T1”, “T2”]}, {schemaName: “OE”, tableName : [“T3”, “T4”]}].

        Parameters:
        tablesForDiscovery - the value to set
        Returns:
        this builder

      • sensitiveTypeIdsForDiscovery

        public SensitiveDataModel.Builder sensitiveTypeIdsForDiscovery​(List<String> sensitiveTypeIdsForDiscovery)
        The OCIDs of the sensitive types to be used by data discovery jobs.
        Parameters:
        sensitiveTypeIdsForDiscovery - the value to set
        Returns:
        this builder

      • sensitiveTypeGroupIdsForDiscovery

        public SensitiveDataModel.Builder sensitiveTypeGroupIdsForDiscovery​(List<String> sensitiveTypeGroupIdsForDiscovery)
        The OCIDs of the sensitive type groups to be used by data discovery jobs.
        Parameters:
        sensitiveTypeGroupIdsForDiscovery - the value to set
        Returns:
        this builder

      • isSampleDataCollectionEnabled

        public SensitiveDataModel.Builder isSampleDataCollectionEnabled​(Boolean isSampleDataCollectionEnabled)
        Indicates if data discovery jobs should collect and store sample data values for the discovered columns.

        Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it’s disabled by default and should be used only if it’s acceptable to store sample data in Data Safe’s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

        Parameters:
        isSampleDataCollectionEnabled - the value to set
        Returns:
        this builder

      • isAppDefinedRelationDiscoveryEnabled

        public SensitiveDataModel.Builder isAppDefinedRelationDiscoveryEnabled​(Boolean isAppDefinedRelationDiscoveryEnabled)
        Indicates if data discovery jobs should identify potential application-level (non-dictionary) referential relationships between columns.

        Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It’s disabled by default and should be used only if there is a need to identify application-level relationships.

        Parameters:
        isAppDefinedRelationDiscoveryEnabled - the value to set
        Returns:
        this builder

      • isIncludeAllSchemas

        public SensitiveDataModel.Builder isIncludeAllSchemas​(Boolean isIncludeAllSchemas)
        Indicates if all the schemas in the associated target database should be scanned by data discovery jobs.

        If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).

        Parameters:
        isIncludeAllSchemas - the value to set
        Returns:
        this builder

      • isIncludeAllSensitiveTypes

        public SensitiveDataModel.Builder isIncludeAllSensitiveTypes​(Boolean isIncludeAllSensitiveTypes)
        Indicates if all the existing sensitive types should be used by data discovery jobs.If it’s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery.
        Parameters:
        isIncludeAllSensitiveTypes - the value to set
        Returns:
        this builder

      • freeformTags

        public SensitiveDataModel.Builder freeformTags​(Map<String,​String> freeformTags)
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

        Example: {"Department": "Finance"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public SensitiveDataModel.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public SensitiveDataModel.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        System tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder