Struct PiiDetectionBuilder 

#[non_exhaustive]
pub struct PiiDetectionBuilder { /* private fields */ }

A builder for PiiDetection.

Implementations

impl PiiDetectionBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of the transform node.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name of the transform node.

pub fn get_name(&self) -> &Option<String>

The name of the transform node.

pub fn inputs(self, input: impl Into<String>) -> Self

Appends an item to inputs.

To override the contents of this collection use set_inputs.

The node ID inputs to the transform.

pub fn set_inputs(self, input: Option<Vec<String>>) -> Self

The node ID inputs to the transform.

pub fn get_inputs(&self) -> &Option<Vec<String>>

The node ID inputs to the transform.

pub fn pii_type(self, input: PiiType) -> Self

Indicates the type of PIIDetection transform.

This field is required.

pub fn set_pii_type(self, input: Option<PiiType>) -> Self

Indicates the type of PIIDetection transform.

pub fn get_pii_type(&self) -> &Option<PiiType>

Indicates the type of PIIDetection transform.

pub fn entity_types_to_detect(self, input: impl Into<String>) -> Self

Appends an item to entity_types_to_detect.

To override the contents of this collection use set_entity_types_to_detect.

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

pub fn set_entity_types_to_detect(self, input: Option<Vec<String>>) -> Self

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

pub fn get_entity_types_to_detect(&self) -> &Option<Vec<String>>

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

pub fn output_column_name(self, input: impl Into<String>) -> Self

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

pub fn set_output_column_name(self, input: Option<String>) -> Self

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

pub fn get_output_column_name(&self) -> &Option<String>

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

pub fn sample_fraction(self, input: f64) -> Self

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

pub fn set_sample_fraction(self, input: Option<f64>) -> Self

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

pub fn get_sample_fraction(&self) -> &Option<f64>

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

pub fn threshold_fraction(self, input: f64) -> Self

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

pub fn set_threshold_fraction(self, input: Option<f64>) -> Self

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

pub fn get_threshold_fraction(&self) -> &Option<f64>

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

pub fn mask_value(self, input: impl Into<String>) -> Self

Indicates the value that will replace the detected entity.

pub fn set_mask_value(self, input: Option<String>) -> Self

Indicates the value that will replace the detected entity.

pub fn get_mask_value(&self) -> &Option<String>

Indicates the value that will replace the detected entity.

pub fn redact_text(self, input: impl Into<String>) -> Self

Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

pub fn set_redact_text(self, input: Option<String>) -> Self

Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

pub fn get_redact_text(&self) -> &Option<String>

Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

pub fn redact_char(self, input: impl Into<String>) -> Self

The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

pub fn set_redact_char(self, input: Option<String>) -> Self

The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

pub fn get_redact_char(&self) -> &Option<String>

The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

pub fn match_pattern(self, input: impl Into<String>) -> Self

A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

pub fn set_match_pattern(self, input: Option<String>) -> Self

A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

pub fn get_match_pattern(&self) -> &Option<String>

A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

pub fn num_left_chars_to_exclude(self, input: i32) -> Self

The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

pub fn set_num_left_chars_to_exclude(self, input: Option<i32>) -> Self

The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

pub fn get_num_left_chars_to_exclude(&self) -> &Option<i32>

The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

pub fn num_right_chars_to_exclude(self, input: i32) -> Self

The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

pub fn set_num_right_chars_to_exclude(self, input: Option<i32>) -> Self

The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

pub fn get_num_right_chars_to_exclude(&self) -> &Option<i32>

The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

pub fn detection_parameters(self, input: impl Into<String>) -> Self

Additional parameters for configuring PII detection behavior and sensitivity settings.

pub fn set_detection_parameters(self, input: Option<String>) -> Self

Additional parameters for configuring PII detection behavior and sensitivity settings.

pub fn get_detection_parameters(&self) -> &Option<String>

Additional parameters for configuring PII detection behavior and sensitivity settings.

pub fn detection_sensitivity(self, input: impl Into<String>) -> Self

The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

pub fn set_detection_sensitivity(self, input: Option<String>) -> Self

The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

pub fn get_detection_sensitivity(&self) -> &Option<String>

The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

pub fn build(self) -> Result<PiiDetection, BuildError>

Consumes the builder and constructs a PiiDetection. This method will fail if any of the following fields are not set:

• name
• inputs
• pii_type
• entity_types_to_detect

Trait Implementations

impl Clone for PiiDetectionBuilder

fn clone(&self) -> PiiDetectionBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PiiDetectionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PiiDetectionBuilder

fn default() -> PiiDetectionBuilder

Returns the “default value” for a type.

impl PartialEq for PiiDetectionBuilder

fn eq(&self, other: &PiiDetectionBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PiiDetectionBuilder