#[non_exhaustive]pub struct PiiDetectionBuilder { /* private fields */ }
Expand description
A builder for PiiDetection
.
Implementations§
Source§impl PiiDetectionBuilder
impl PiiDetectionBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the transform node.
This field is required.Sourcepub fn inputs(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_inputs(self, input: Option<Vec<String>>) -> Self
pub fn set_inputs(self, input: Option<Vec<String>>) -> Self
The node ID inputs to the transform.
Sourcepub fn get_inputs(&self) -> &Option<Vec<String>>
pub fn get_inputs(&self) -> &Option<Vec<String>>
The node ID inputs to the transform.
Sourcepub fn pii_type(self, input: PiiType) -> Self
pub fn pii_type(self, input: PiiType) -> Self
Indicates the type of PIIDetection transform.
This field is required.Sourcepub fn set_pii_type(self, input: Option<PiiType>) -> Self
pub fn set_pii_type(self, input: Option<PiiType>) -> Self
Indicates the type of PIIDetection transform.
Sourcepub fn get_pii_type(&self) -> &Option<PiiType>
pub fn get_pii_type(&self) -> &Option<PiiType>
Indicates the type of PIIDetection transform.
Sourcepub fn entity_types_to_detect(self, input: impl Into<String>) -> Self
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
Sourcepub fn set_entity_types_to_detect(self, input: Option<Vec<String>>) -> Self
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
Sourcepub fn get_entity_types_to_detect(&self) -> &Option<Vec<String>>
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
Sourcepub fn output_column_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_output_column_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_output_column_name(&self) -> &Option<String>
pub fn get_output_column_name(&self) -> &Option<String>
Indicates the output column name that will contain any entity type detected in that row.
Sourcepub fn sample_fraction(self, input: f64) -> Self
pub fn sample_fraction(self, input: f64) -> Self
Indicates the fraction of the data to sample when scanning for PII entities.
Sourcepub fn set_sample_fraction(self, input: Option<f64>) -> Self
pub fn set_sample_fraction(self, input: Option<f64>) -> Self
Indicates the fraction of the data to sample when scanning for PII entities.
Sourcepub fn get_sample_fraction(&self) -> &Option<f64>
pub fn get_sample_fraction(&self) -> &Option<f64>
Indicates the fraction of the data to sample when scanning for PII entities.
Sourcepub fn threshold_fraction(self, input: f64) -> Self
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.
Sourcepub fn set_threshold_fraction(self, input: Option<f64>) -> Self
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.
Sourcepub fn get_threshold_fraction(&self) -> &Option<f64>
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.
Sourcepub fn mask_value(self, input: impl Into<String>) -> Self
pub fn mask_value(self, input: impl Into<String>) -> Self
Indicates the value that will replace the detected entity.
Sourcepub fn set_mask_value(self, input: Option<String>) -> Self
pub fn set_mask_value(self, input: Option<String>) -> Self
Indicates the value that will replace the detected entity.
Sourcepub fn get_mask_value(&self) -> &Option<String>
pub fn get_mask_value(&self) -> &Option<String>
Indicates the value that will replace the detected entity.
Sourcepub fn build(self) -> Result<PiiDetection, BuildError>
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:
Trait Implementations§
Source§impl Clone for PiiDetectionBuilder
impl Clone for PiiDetectionBuilder
Source§fn clone(&self) -> PiiDetectionBuilder
fn clone(&self) -> PiiDetectionBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PiiDetectionBuilder
impl Debug for PiiDetectionBuilder
Source§impl Default for PiiDetectionBuilder
impl Default for PiiDetectionBuilder
Source§fn default() -> PiiDetectionBuilder
fn default() -> PiiDetectionBuilder
Source§impl PartialEq for PiiDetectionBuilder
impl PartialEq for PiiDetectionBuilder
impl StructuralPartialEq for PiiDetectionBuilder
Auto Trait Implementations§
impl Freeze for PiiDetectionBuilder
impl RefUnwindSafe for PiiDetectionBuilder
impl Send for PiiDetectionBuilder
impl Sync for PiiDetectionBuilder
impl Unpin for PiiDetectionBuilder
impl UnwindSafe for PiiDetectionBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);