Interface PIIDetection.Builder

    • Method Detail

      • name

        PIIDetection.Builder name​(String name)

        The name of the transform node.

        Parameters:
        name - The name of the transform node.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inputs

        PIIDetection.Builder inputs​(Collection<String> inputs)

        The node ID inputs to the transform.

        Parameters:
        inputs - The node ID inputs to the transform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inputs

        PIIDetection.Builder inputs​(String... inputs)

        The node ID inputs to the transform.

        Parameters:
        inputs - The node ID inputs to the transform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • piiType

        PIIDetection.Builder piiType​(String piiType)

        Indicates the type of PIIDetection transform.

        Parameters:
        piiType - Indicates the type of PIIDetection transform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PiiType, PiiType
      • piiType

        PIIDetection.Builder piiType​(PiiType piiType)

        Indicates the type of PIIDetection transform.

        Parameters:
        piiType - Indicates the type of PIIDetection transform.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PiiType, PiiType
      • entityTypesToDetect

        PIIDetection.Builder entityTypesToDetect​(Collection<String> entityTypesToDetect)

        Indicates the types of entities the PIIDetection transform will identify as PII data.

        PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER ,USA_DEA_NUMBER,USA_DRIVING_LICENSE

        Parameters:
        entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.

        PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD ,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • entityTypesToDetect

        PIIDetection.Builder entityTypesToDetect​(String... entityTypesToDetect)

        Indicates the types of entities the PIIDetection transform will identify as PII data.

        PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER ,USA_DEA_NUMBER,USA_DRIVING_LICENSE

        Parameters:
        entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.

        PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD ,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • outputColumnName

        PIIDetection.Builder outputColumnName​(String outputColumnName)

        Indicates the output column name that will contain any entity type detected in that row.

        Parameters:
        outputColumnName - Indicates the output column name that will contain any entity type detected in that row.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sampleFraction

        PIIDetection.Builder sampleFraction​(Double sampleFraction)

        Indicates the fraction of the data to sample when scanning for PII entities.

        Parameters:
        sampleFraction - Indicates the fraction of the data to sample when scanning for PII entities.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • thresholdFraction

        PIIDetection.Builder thresholdFraction​(Double thresholdFraction)

        Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

        Parameters:
        thresholdFraction - Indicates the fraction of the data that must be met in order for a column to be identified as PII data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • maskValue

        PIIDetection.Builder maskValue​(String maskValue)

        Indicates the value that will replace the detected entity.

        Parameters:
        maskValue - Indicates the value that will replace the detected entity.
        Returns:
        Returns a reference to this object so that method calls can be chained together.