Package com.oracle.bmc.datasafe.model

Class DiscoveryJob.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • id

        public DiscoveryJob.Builder id​(String id)
        The OCID of the discovery job.
        Parameters:
        id - the value to set
        Returns:
        this builder

      • discoveryType

        public DiscoveryJob.Builder discoveryType​(DiscoveryJob.DiscoveryType discoveryType)
        The type of the discovery job.

        It defines the job’s scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

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

      • displayName

        public DiscoveryJob.Builder displayName​(String displayName)
        The display name of the discovery job.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • compartmentId

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

      • timeStarted

        public DiscoveryJob.Builder timeStarted​(Date timeStarted)
        The date and time the discovery job started, in the format defined by RFC3339.
        Parameters:
        timeStarted - the value to set
        Returns:
        this builder

      • timeFinished

        public DiscoveryJob.Builder timeFinished​(Date timeFinished)
        The date and time the discovery job finished, in the format defined by RFC3339..
        Parameters:
        timeFinished - the value to set
        Returns:
        this builder

      • sensitiveDataModelId

        public DiscoveryJob.Builder sensitiveDataModelId​(String sensitiveDataModelId)
        The OCID of the sensitive data model associated with the discovery job.
        Parameters:
        sensitiveDataModelId - the value to set
        Returns:
        this builder

      • targetId

        public DiscoveryJob.Builder targetId​(String targetId)
        The OCID of the target database associated with the discovery job.
        Parameters:
        targetId - the value to set
        Returns:
        this builder

      • schemasForDiscovery

        public DiscoveryJob.Builder schemasForDiscovery​(List<String> schemasForDiscovery)
        The schemas used for data discovery.
        Parameters:
        schemasForDiscovery - the value to set
        Returns:
        this builder

      • tablesForDiscovery

        public DiscoveryJob.Builder tablesForDiscovery​(List<TablesForDiscovery> tablesForDiscovery)
        The data discovery jobs will scan the tables specified here, including both schemas and tables.
        Parameters:
        tablesForDiscovery - the value to set
        Returns:
        this builder

      • sensitiveTypeIdsForDiscovery

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

      • sensitiveTypeGroupIdsForDiscovery

        public DiscoveryJob.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 DiscoveryJob.Builder isSampleDataCollectionEnabled​(Boolean isSampleDataCollectionEnabled)
        Indicates if the discovery job 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 DiscoveryJob.Builder isAppDefinedRelationDiscoveryEnabled​(Boolean isAppDefinedRelationDiscoveryEnabled)
        Indicates if the discovery job 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 DiscoveryJob.Builder isIncludeAllSchemas​(Boolean isIncludeAllSchemas)
        Indicates if all the schemas in the associated target database are used for data discovery.

        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 DiscoveryJob.Builder isIncludeAllSensitiveTypes​(Boolean isIncludeAllSensitiveTypes)
        Indicates if all the existing sensitive types are used for data discovery.

        If it’s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

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

      • totalSchemasScanned

        public DiscoveryJob.Builder totalSchemasScanned​(Long totalSchemasScanned)
        The total number of schemas scanned by the discovery job.
        Parameters:
        totalSchemasScanned - the value to set
        Returns:
        this builder

      • totalObjectsScanned

        public DiscoveryJob.Builder totalObjectsScanned​(Long totalObjectsScanned)
        The total number of objects (tables and editioning views) scanned by the discovery job.
        Parameters:
        totalObjectsScanned - the value to set
        Returns:
        this builder

      • totalColumnsScanned

        public DiscoveryJob.Builder totalColumnsScanned​(Long totalColumnsScanned)
        The total number of columns scanned by the discovery job.
        Parameters:
        totalColumnsScanned - the value to set
        Returns:
        this builder

      • totalNewSensitiveColumns

        public DiscoveryJob.Builder totalNewSensitiveColumns​(Long totalNewSensitiveColumns)
        The total number of new sensitive columns identified by the discovery job.
        Parameters:
        totalNewSensitiveColumns - the value to set
        Returns:
        this builder

      • totalModifiedSensitiveColumns

        public DiscoveryJob.Builder totalModifiedSensitiveColumns​(Long totalModifiedSensitiveColumns)
        The total number of modified sensitive columns identified by the discovery job.
        Parameters:
        totalModifiedSensitiveColumns - the value to set
        Returns:
        this builder

      • totalDeletedSensitiveColumns

        public DiscoveryJob.Builder totalDeletedSensitiveColumns​(Long totalDeletedSensitiveColumns)
        The total number of deleted sensitive columns identified by the discovery job.
        Parameters:
        totalDeletedSensitiveColumns - the value to set
        Returns:
        this builder

      • freeformTags

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