Struct SensitiveDataItem

#[non_exhaustive]
pub struct SensitiveDataItem {
    pub category: Option<SensitiveDataItemCategory>,
    pub detections: Option<Vec<DefaultDetection>>,
    pub total_count: Option<i64>,
}

Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

category: Option<SensitiveDataItemCategory>

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

detections: Option<Vec<DefaultDetection>>

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

total_count: Option<i64>

The total number of occurrences of the sensitive data that was detected.

Implementations

impl SensitiveDataItem

pub fn category(&self) -> Option<&SensitiveDataItemCategory>

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

pub fn detections(&self) -> &[DefaultDetection]

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .detections.is_none().

pub fn total_count(&self) -> Option<i64>

The total number of occurrences of the sensitive data that was detected.

impl SensitiveDataItem

pub fn builder() -> SensitiveDataItemBuilder

Creates a new builder-style object to manufacture SensitiveDataItem.

Trait Implementations

impl Clone for SensitiveDataItem

fn clone(&self) -> SensitiveDataItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SensitiveDataItem

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

Formats the value using the given formatter.

impl PartialEq for SensitiveDataItem

fn eq(&self, other: &SensitiveDataItem) -> 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 SensitiveDataItem