Package com.oracle.bmc.datasafe.model

Class MaskingPolicy.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public MaskingPolicy.Builder id​(String id)
        The OCID of the masking policy.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • compartmentId

        public MaskingPolicy.Builder compartmentId​(String compartmentId)
        The OCID of the compartment that contains the masking policy.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • displayName

        public MaskingPolicy.Builder displayName​(String displayName)
        The display name of the masking policy.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • timeCreated

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

      • lifecycleState

        public MaskingPolicy.Builder lifecycleState​(MaskingLifecycleState lifecycleState)
        The current state of the masking policy.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • timeUpdated

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

      • description

        public MaskingPolicy.Builder description​(String description)
        The description of the masking policy.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • isDropTempTablesEnabled

        public MaskingPolicy.Builder isDropTempTablesEnabled​(Boolean isDropTempTablesEnabled)
        Indicates if the temporary tables created during a masking operation should be dropped after masking.

        It’s enabled by default. Set this attribute to false to preserve the temporary tables. Masking creates temporary tables that map the original sensitive data values to mask values. By default, these temporary tables are dropped after masking. But, in some cases, you may want to preserve this information to track how masking changed your data. Note that doing so compromises security. These tables must be dropped before the database is available for unprivileged users.

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

      • isRedoLoggingEnabled

        public MaskingPolicy.Builder isRedoLoggingEnabled​(Boolean isRedoLoggingEnabled)
        Indicates if redo logging is enabled during a masking operation.

        It’s disabled by default. Set this attribute to true to enable redo logging. By default, masking disables redo logging and flashback logging to purge any original unmasked data from logs. However, in certain circumstances when you only want to test masking, rollback changes, and retry masking, you could enable logging and use a flashback database to retrieve the original unmasked data after it has been masked.

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

      • isRefreshStatsEnabled

        public MaskingPolicy.Builder isRefreshStatsEnabled​(Boolean isRefreshStatsEnabled)
        Indicates if statistics gathering is enabled.

        It’s enabled by default. Set this attribute to false to disable statistics gathering. The masking process gathers statistics on masked database tables after masking completes.

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

      • parallelDegree

        public MaskingPolicy.Builder parallelDegree​(String parallelDegree)
        Specifies options to enable parallel execution when running data masking.

        Allowed values are ‘NONE’ (no parallelism), ‘DEFAULT’ (the Oracle Database computes the optimum degree of parallelism) or an integer value to be used as the degree of parallelism. Parallel execution helps effectively use multiple CPUs and improve masking performance. Refer to the Oracle Database parallel execution framework when choosing an explicit degree of parallelism.

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

      • recompile

        public MaskingPolicy.Builder recompile​(MaskingPolicy.Recompile recompile)
        Specifies how to recompile invalid objects post data masking.

        Allowed values are ‘SERIAL’ (recompile in serial), ‘PARALLEL’ (recompile in parallel), ‘NONE’ (do not recompile). If it’s set to PARALLEL, the value of parallelDegree attribute is used. Use the built-in UTL_RECOMP package to recompile any remaining invalid objects after masking completes.

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

      • preMaskingScript

        public MaskingPolicy.Builder preMaskingScript​(String preMaskingScript)
        A pre-masking script, which can contain SQL and PL/SQL statements.

        It’s executed before the core masking script generated using the masking policy. It’s usually used to perform any preparation or prerequisite work before masking data.

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

      • postMaskingScript

        public MaskingPolicy.Builder postMaskingScript​(String postMaskingScript)
        A post-masking script, which can contain SQL and PL/SQL statements.

        It’s executed after the core masking script generated using the masking policy. It’s usually used to perform additional transformation or cleanup work after masking.

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

      • freeformTags

        public MaskingPolicy.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 MaskingPolicy.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