Class DataMaskingPolicy (0.5.3)

DataMaskingPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The data masking policy that is used to specify data masking rule.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attribute
Name	Description
`predefined_expression`	`google.cloud.bigquery_datapolicies_v1.types.DataMaskingPolicy.PredefinedExpression` A predefined masking expression. This field is a member of `oneof`_ `masking_expression`.

Classes

PredefinedExpression

PredefinedExpression(value)

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

Values: PREDEFINED_EXPRESSION_UNSPECIFIED (0): Default, unspecified predefined expression. No masking will take place since no expression is specified. SHA256 (3): Masking expression to replace data with SHA-256 hash. ALWAYS_NULL (5): Masking expression to replace data with NULLs. DEFAULT_MASKING_VALUE (7): 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
LAST_FOUR_CHARACTERS (9):
    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.
FIRST_FOUR_CHARACTERS (10):
    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.
EMAIL_MASK (12):
    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 <https://cloud.google.com/bigquery/docs/column-data-masking-intro#masking_options>`__.
DATE_YEAR_MASK (13):
    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.

Class DataMaskingPolicy (0.5.3)

Attribute

Classes

PredefinedExpression