Package com.oracle.bmc.datasafe.model

Class SensitiveColumnSummary.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • key

        public SensitiveColumnSummary.Builder key​(String key)
        The unique key that identifies the sensitive column.

        It’s numeric and unique within a sensitive data model.

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

      • sensitiveDataModelId

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

      • lifecycleDetails

        public SensitiveColumnSummary.Builder lifecycleDetails​(String lifecycleDetails)
        Details about the current state of the sensitive column.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • timeCreated

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

      • timeUpdated

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

      • appName

        public SensitiveColumnSummary.Builder appName​(String appName)
        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.

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

      • schemaName

        public SensitiveColumnSummary.Builder schemaName​(String schemaName)
        The database schema that contains the sensitive column.
        Parameters:
        schemaName - the value to set
        Returns:
        this builder

      • objectName

        public SensitiveColumnSummary.Builder objectName​(String objectName)
        The database object that contains the sensitive column.
        Parameters:
        objectName - the value to set
        Returns:
        this builder

      • columnName

        public SensitiveColumnSummary.Builder columnName​(String columnName)
        The name of the sensitive column.
        Parameters:
        columnName - the value to set
        Returns:
        this builder

      • dataType

        public SensitiveColumnSummary.Builder dataType​(String dataType)
        The data type of the sensitive column.
        Parameters:
        dataType - the value to set
        Returns:
        this builder

      • status

        public SensitiveColumnSummary.Builder status​(SensitiveColumnSummary.Status status)
        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 again.

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

      • sensitiveTypeId

        public SensitiveColumnSummary.Builder sensitiveTypeId​(String sensitiveTypeId)
        The OCID of the sensitive type associated with the sensitive column.
        Parameters:
        sensitiveTypeId - the value to set
        Returns:
        this builder

      • source

        public SensitiveColumnSummary.Builder source​(SensitiveColumnSummary.Source source)
        The source of the sensitive column.

        DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.

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

      • parentColumnKeys

        public SensitiveColumnSummary.Builder parentColumnKeys​(List<String> parentColumnKeys)
        Unique keys identifying the columns that are parents of the sensitive column.

        At present, it tracks a single parent only.

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

      • relationType

        public SensitiveColumnSummary.Builder relationType​(SensitiveColumnSummary.RelationType relationType)
        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.

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

      • estimatedDataValueCount

        public SensitiveColumnSummary.Builder estimatedDataValueCount​(Long estimatedDataValueCount)
        The estimated number of data values the column has in the associated database.
        Parameters:
        estimatedDataValueCount - the value to set
        Returns:
        this builder

      • sampleDataValues

        public SensitiveColumnSummary.Builder sampleDataValues​(List<String> sampleDataValues)
        Original data values collected for the sensitive column from the associated database.

        Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

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