# Google Cloud Data Loss Prevention v2 API - Class CharacterMaskConfig (4.26.0)

4.26.0 (latest) 4.25.0 4.24.0 4.23.0 4.22.0 4.21.0 4.20.0 4.19.0 4.18.0 4.17.0 4.16.0 4.15.0 4.14.0 4.13.0 4.12.0 4.11.0 4.10.0 4.9.0 4.8.0 4.7.0 4.6.0 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 4.0.0 3.5.0 3.4.0 3.3.0 3.2.0 2.16.0 2.15.0

    public sealed class CharacterMaskConfig : IMessage<CharacterMaskConfig>, IEquatable<CharacterMaskConfig>, IDeepCloneable<CharacterMaskConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Data Loss Prevention v2 API class CharacterMaskConfig.

Partially mask a string by replacing a given number of characters with a
fixed character. Masking can start from the beginning or end of the string.
This can be used on data of any type (numbers, longs, and so on) and when
de-identifying structured data we'll attempt to preserve the original data's
type. (This allows you to take a long like 123 and modify it to a string like
\*\*3.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> CharacterMaskConfig

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[CharacterMaskConfig](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.CharacterMaskConfig), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[CharacterMaskConfig](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.CharacterMaskConfig), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[CharacterMaskConfig](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.CharacterMaskConfig), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Dlp.V2](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2)

## Assembly

Google.Cloud.Dlp.V2.dll

## Constructors

### CharacterMaskConfig()

    public CharacterMaskConfig()

### CharacterMaskConfig(CharacterMaskConfig)

    public CharacterMaskConfig(CharacterMaskConfig other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.CharacterMaskConfig` |

## Properties

### CharactersToIgnore

    public RepeatedField<CharsToIgnore> CharactersToIgnore { get; }

When masking a string, items in this list will be skipped when replacing
characters. For example, if the input string is `555-555-5555` and you
instruct Cloud DLP to skip `-` and mask 5 characters with `*`, Cloud DLP
returns `***-**5-5555`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Dlp.V2/latest/Google.Cloud.Dlp.V2.CharsToIgnore` |   |

### MaskingCharacter

    public string MaskingCharacter { get; set; }

Character to use to mask the sensitive values\&mdash;for example, `*` for an
alphabetic string such as a name, or `0` for a numeric string such as ZIP
code or credit card number. This string must have a length of 1. If not
supplied, this value defaults to `*` for strings, and `0` for digits.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### NumberToMask

    public int NumberToMask { get; set; }

Number of characters to mask. If not set, all matching chars will be
masked. Skipped characters do not count towards this tally.

If `number_to_mask` is negative, this denotes inverse masking. Cloud DLP
masks all but a number of characters.
For example, suppose you have the following values:

- `masking_character` is `*`
- `number_to_mask` is `-4`
- `reverse_order` is `false`
- `CharsToIgnore` includes `-`
- Input string is `1234-5678-9012-3456`

The resulting de-identified string is
`****-****-****-3456`. Cloud DLP masks all but the last four characters.
If `reverse_order` is `true`, all but the first four characters are masked
as `1234-****-****-****`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### ReverseOrder

    public bool ReverseOrder { get; set; }

Mask characters in reverse order. For example, if `masking_character` is
`0`, `number_to_mask` is `14`, and `reverse_order` is `false`, then the
input string `1234-5678-9012-3456` is masked as `00000000000000-3456`.
If `masking_character` is `*`, `number_to_mask` is `3`, and `reverse_order`
is `true`, then the string `12345` is masked as `12***`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |