Interface EntityDetectorConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EntityDetectorConfiguration.Builder,EntityDetectorConfiguration>, SdkBuilder<EntityDetectorConfiguration.Builder,EntityDetectorConfiguration>, SdkPojo
Enclosing class:
EntityDetectorConfiguration
public static interface EntityDetectorConfiguration.Builder extends SdkPojo, CopyableBuilder<EntityDetectorConfiguration.Builder,EntityDetectorConfiguration>

  • Method Details

    • entityTypes

      EntityDetectorConfiguration.Builder entityTypes(Collection<String> entityTypes)

      Entity types to detect. Can be any of the following:

      • USA_SSN

      • EMAIL

      • USA_ITIN

      • USA_PASSPORT_NUMBER

      • PHONE_NUMBER

      • USA_DRIVING_LICENSE

      • BANK_ACCOUNT

      • CREDIT_CARD

      • IP_ADDRESS

      • MAC_ADDRESS

      • USA_DEA_NUMBER

      • USA_HCPCS_CODE

      • USA_NATIONAL_PROVIDER_IDENTIFIER

      • USA_NATIONAL_DRUG_CODE

      • USA_HEALTH_INSURANCE_CLAIM_NUMBER

      • USA_MEDICARE_BENEFICIARY_IDENTIFIER

      • USA_CPT_CODE

      • PERSON_NAME

      • DATE

      The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

      Parameters:
      entityTypes - Entity types to detect. Can be any of the following:

      • USA_SSN

      • EMAIL

      • USA_ITIN

      • USA_PASSPORT_NUMBER

      • PHONE_NUMBER

      • USA_DRIVING_LICENSE

      • BANK_ACCOUNT

      • CREDIT_CARD

      • IP_ADDRESS

      • MAC_ADDRESS

      • USA_DEA_NUMBER

      • USA_HCPCS_CODE

      • USA_NATIONAL_PROVIDER_IDENTIFIER

      • USA_NATIONAL_DRUG_CODE

      • USA_HEALTH_INSURANCE_CLAIM_NUMBER

      • USA_MEDICARE_BENEFICIARY_IDENTIFIER

      • USA_CPT_CODE

      • PERSON_NAME

      • DATE

      The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

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

    • entityTypes

      EntityDetectorConfiguration.Builder entityTypes(String... entityTypes)

      Entity types to detect. Can be any of the following:

      • USA_SSN

      • EMAIL

      • USA_ITIN

      • USA_PASSPORT_NUMBER

      • PHONE_NUMBER

      • USA_DRIVING_LICENSE

      • BANK_ACCOUNT

      • CREDIT_CARD

      • IP_ADDRESS

      • MAC_ADDRESS

      • USA_DEA_NUMBER

      • USA_HCPCS_CODE

      • USA_NATIONAL_PROVIDER_IDENTIFIER

      • USA_NATIONAL_DRUG_CODE

      • USA_HEALTH_INSURANCE_CLAIM_NUMBER

      • USA_MEDICARE_BENEFICIARY_IDENTIFIER

      • USA_CPT_CODE

      • PERSON_NAME

      • DATE

      The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

      Parameters:
      entityTypes - Entity types to detect. Can be any of the following:

      • USA_SSN

      • EMAIL

      • USA_ITIN

      • USA_PASSPORT_NUMBER

      • PHONE_NUMBER

      • USA_DRIVING_LICENSE

      • BANK_ACCOUNT

      • CREDIT_CARD

      • IP_ADDRESS

      • MAC_ADDRESS

      • USA_DEA_NUMBER

      • USA_HCPCS_CODE

      • USA_NATIONAL_PROVIDER_IDENTIFIER

      • USA_NATIONAL_DRUG_CODE

      • USA_HEALTH_INSURANCE_CLAIM_NUMBER

      • USA_MEDICARE_BENEFICIARY_IDENTIFIER

      • USA_CPT_CODE

      • PERSON_NAME

      • DATE

      The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

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

    • allowedStatistics

      EntityDetectorConfiguration.Builder allowedStatistics(Collection<AllowedStatistics> allowedStatistics)

      Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

      Parameters:
      allowedStatistics - Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStatistics

      EntityDetectorConfiguration.Builder allowedStatistics(AllowedStatistics... allowedStatistics)

      Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

      Parameters:
      allowedStatistics - Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedStatistics

      EntityDetectorConfiguration.Builder allowedStatistics(Consumer<AllowedStatistics.Builder>... allowedStatistics)

      Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

      This is a convenience method that creates an instance of the AllowedStatistics.Builder avoiding the need to create one manually via AllowedStatistics.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to allowedStatistics(List<AllowedStatistics>).

      Parameters:
      allowedStatistics - a consumer that will call methods on AllowedStatistics.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: