Enum PredefinedExpression 

#[non_exhaustive]
pub enum PredefinedExpression {
    Unspecified,
    Sha256,
    AlwaysNull,
    DefaultMaskingValue,
    LastFourCharacters,
    FirstFourCharacters,
    EmailMask,
    DateYearMask,
    UnknownValue(UnknownValue),
}

The available masking rules. Learn more here: https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

Default, unspecified predefined expression. No masking will take place since no expression is specified.

Sha256

Masking expression to replace data with SHA-256 hash.

AlwaysNull

Masking expression to replace data with NULLs.

DefaultMaskingValue

Masking expression to replace data with their default masking values. The default masking values for each type listed as below:

• STRING: “”
• BYTES: b’’
• INTEGER: 0
• FLOAT: 0.0
• NUMERIC: 0
• BOOLEAN: FALSE
• TIMESTAMP: 1970-01-01 00:00:00 UTC
• DATE: 1970-01-01
• TIME: 00:00:00
• DATETIME: 1970-01-01T00:00:00
• GEOGRAPHY: POINT(0 0)
• BIGNUMERIC: 0
• ARRAY: []
• STRUCT: NOT_APPLICABLE
• JSON: NULL

LastFourCharacters

Masking expression shows the last four characters of text. The masking behavior is as follows:

• If text length > 4 characters: Replace text with XXXXX, append last four characters of original text.
• If text length <= 4 characters: Apply SHA-256 hash.

FirstFourCharacters

Masking expression shows the first four characters of text. The masking behavior is as follows:

• If text length > 4 characters: Replace text with XXXXX, prepend first four characters of original text.
• If text length <= 4 characters: Apply SHA-256 hash.

EmailMask

Masking expression for email addresses. The masking behavior is as follows:

• Syntax-valid email address: Replace username with XXXXX. For example, cloudysanfrancisco@gmail.com becomes XXXXX@gmail.com.
• Syntax-invalid email address: Apply SHA-256 hash.

For more information, see Email mask.

DateYearMask

Masking expression to only show the year of Date, DateTime and TimeStamp. For example, with the year 2076:

• DATE : 2076-01-01
• DATETIME : 2076-01-01T00:00:00
• TIMESTAMP : 2076-01-01 00:00:00 UTC

Truncation occurs according to the UTC time zone. To change this, adjust the default time zone using the time_zone system variable. For more information, see the System variables reference.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using PredefinedExpression::value or PredefinedExpression::name.

Implementations

impl PredefinedExpression

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

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for PredefinedExpression

fn clone(&self) -> PredefinedExpression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PredefinedExpression

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

Formats the value using the given formatter.

impl Default for PredefinedExpression

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PredefinedExpression

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PredefinedExpression

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

Formats the value using the given formatter.

impl From<&str> for PredefinedExpression

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for PredefinedExpression

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for PredefinedExpression

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PredefinedExpression