Class: Google::Apis::DlpV2::GooglePrivacyDlpV2PrimitiveTransformation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dlp_v2/classes.rb,
lib/google/apis/dlp_v2/representations.rb,
lib/google/apis/dlp_v2/representations.rb

Overview

A rule for transforming a value.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GooglePrivacyDlpV2PrimitiveTransformation

Returns a new instance of GooglePrivacyDlpV2PrimitiveTransformation.



5427
5428
5429
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5427

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bucketing_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2BucketingConfig

Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. Corresponds to the JSON property bucketingConfig

Returns:



5335
5336
5337
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5335

def bucketing_config
  @bucketing_config
end

#character_mask_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2CharacterMaskConfig

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. Corresponds to the JSON property characterMaskConfig

Returns:



5344
5345
5346
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5344

def character_mask_config
  @character_mask_config
end

#crypto_deterministic_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2CryptoDeterministicConfig

Pseudonymization method that generates deterministic encryption for the given input. Outputs a base64 encoded representation of the encrypted output. Uses AES-SIV based on the RFC https://tools.ietf.org/html/rfc5297. Corresponds to the JSON property cryptoDeterministicConfig

Returns:



5351
5352
5353
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5351

def crypto_deterministic_config
  @crypto_deterministic_config
end

#crypto_hash_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2CryptoHashConfig

Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. The key size must be either 32 or 64 bytes. Outputs a base64 encoded representation of the hashed output (for example, L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=). Currently, only string and integer values can be hashed. See https://cloud.google.com/dlp/docs/ pseudonymization to learn more. Corresponds to the JSON property cryptoHashConfig

Returns:



5361
5362
5363
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5361

def crypto_hash_config
  @crypto_hash_config
end

#crypto_replace_ffx_fpe_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2CryptoReplaceFfxFpeConfig

Replaces an identifier with a surrogate using Format Preserving Encryption ( FPE) with the FFX mode of operation; however when used in the ReidentifyContent API method, it serves the opposite function by reversing the surrogate back into the original identifier. The identifier must be encoded as ASCII. For a given crypto key and context, the same identifier will be replaced with the same surrogate. Identifiers must be at least two characters long. In the case that the identifier is the empty string, it will be skipped. See https://cloud.google.com/dlp/docs/pseudonymization to learn more. Note: We recommend using CryptoDeterministicConfig for all use cases which do not require preserving the input alphabet space and size, plus warrant referential integrity. Corresponds to the JSON property cryptoReplaceFfxFpeConfig

Returns:



5376
5377
5378
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5376

def crypto_replace_ffx_fpe_config
  @crypto_replace_ffx_fpe_config
end

#date_shift_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DateShiftConfig

Shifts dates by random number of days, with option to be consistent for the same context. See https://cloud.google.com/dlp/docs/concepts-date-shifting to learn more. Corresponds to the JSON property dateShiftConfig

Returns:



5383
5384
5385
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5383

def date_shift_config
  @date_shift_config
end

#fixed_size_bucketing_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2FixedSizeBucketingConfig

Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies. The transformed value will be a hyphenated string of lower_bound- upper_bound. For example, if lower_bound = 10 and upper_bound = 20, all values that are within this bucket will be replaced with "10-20". This can be used on data of type: double, long. If the bound Value type differs from the type of data being transformed, we will first attempt converting the type of the data to be transformed to match the type of the bound before comparing. See https://cloud.google.com/dlp/docs/concepts-bucketing to learn more. Corresponds to the JSON property fixedSizeBucketingConfig

Returns:



5397
5398
5399
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5397

def fixed_size_bucketing_config
  @fixed_size_bucketing_config
end

#redact_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2RedactConfig

Redact a given value. For example, if used with an InfoTypeTransformation transforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '. Corresponds to the JSON property redactConfig

Returns:



5404
5405
5406
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5404

def redact_config
  @redact_config
end

#replace_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ReplaceValueConfig

Replace each input value with a given Value. Corresponds to the JSON property replaceConfig

Returns:



5409
5410
5411
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5409

def replace_config
  @replace_config
end

#replace_dictionary_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ReplaceDictionaryConfig

Replace each input value with a value randomly selected from the dictionary. Corresponds to the JSON property replaceDictionaryConfig

Returns:



5414
5415
5416
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5414

def replace_dictionary_config
  @replace_dictionary_config
end

#replace_with_info_type_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ReplaceWithInfoTypeConfig

Replace each matching finding with the name of the info_type. Corresponds to the JSON property replaceWithInfoTypeConfig

Returns:



5419
5420
5421
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5419

def replace_with_info_type_config
  @replace_with_info_type_config
end

#time_part_config ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2TimePartConfig

For use with Date, Timestamp, and TimeOfDay, extract or preserve a portion of the value. Corresponds to the JSON property timePartConfig

Returns:



5425
5426
5427
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5425

def time_part_config
  @time_part_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
 
# File 'lib/google/apis/dlp_v2/classes.rb', line 5432

def update!(**args)
  @bucketing_config = args[:bucketing_config] if args.key?(:bucketing_config)
  @character_mask_config = args[:character_mask_config] if args.key?(:character_mask_config)
  @crypto_deterministic_config = args[:crypto_deterministic_config] if args.key?(:crypto_deterministic_config)
  @crypto_hash_config = args[:crypto_hash_config] if args.key?(:crypto_hash_config)
  @crypto_replace_ffx_fpe_config = args[:crypto_replace_ffx_fpe_config] if args.key?(:crypto_replace_ffx_fpe_config)
  @date_shift_config = args[:date_shift_config] if args.key?(:date_shift_config)
  @fixed_size_bucketing_config = args[:fixed_size_bucketing_config] if args.key?(:fixed_size_bucketing_config)
  @redact_config = args[:redact_config] if args.key?(:redact_config)
  @replace_config = args[:replace_config] if args.key?(:replace_config)
  @replace_dictionary_config = args[:replace_dictionary_config] if args.key?(:replace_dictionary_config)
  @replace_with_info_type_config = args[:replace_with_info_type_config] if args.key?(:replace_with_info_type_config)
  @time_part_config = args[:time_part_config] if args.key?(:time_part_config)
end