GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata (Cloud Healthcare API v1beta1-rev20241009-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.healthcare.v1beta1.model.GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata
extends com.google.api.client.json.GenericJson
```
Specifies the FHIR paths to match and how to handle the de-identification of matching fields.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Healthcare API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata()

Constructors
Constructor and Description
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`clone()`
`CharacterMaskField`	`getCharacterMaskField()` Replace the field's value with a masking character.
`CleanTextField`	`getCleanTextField()` Inspect the field's text and transform sensitive text.
`CryptoHashField`	`getCryptoHashField()` Replace field value with a hash of that value.
`DateShiftField`	`getDateShiftField()` Shift the date by a randomized number of days.
`KeepField`	`getKeepField()` Keep the field unchanged.
`List<String>`	`getPaths()` List of paths to FHIR fields to redact.
`RemoveField`	`getRemoveField()` Remove the field.
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`set(String fieldName, Object value)`
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`setCharacterMaskField(CharacterMaskField characterMaskField)` Replace the field's value with a masking character.
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`setCleanTextField(CleanTextField cleanTextField)` Inspect the field's text and transform sensitive text.
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`setCryptoHashField(CryptoHashField cryptoHashField)` Replace field value with a hash of that value.
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`setDateShiftField(DateShiftField dateShiftField)` Shift the date by a randomized number of days.
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`setKeepField(KeepField keepField)` Keep the field unchanged.
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`setPaths(List<String> paths)` List of paths to FHIR fields to redact.
`GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata`	`setRemoveField(RemoveField removeField)` Remove the field.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata()
```
- Method Detail
  - getCharacterMaskField
```
public CharacterMaskField getCharacterMaskField()
```
    Replace the field's value with a masking character. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
    
    Returns:
    
    value or null for none
  - setCharacterMaskField
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata setCharacterMaskField(CharacterMaskField characterMaskField)
```
    Replace the field's value with a masking character. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
    
    Parameters:
    
    characterMaskField - characterMaskField or null for none
  - getCleanTextField
```
public CleanTextField getCleanTextField()
```
    Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
    
    Returns:
    
    value or null for none
  - setCleanTextField
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata setCleanTextField(CleanTextField cleanTextField)
```
    Inspect the field's text and transform sensitive text. Configure using TextConfig. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
    
    Parameters:
    
    cleanTextField - cleanTextField or null for none
  - getCryptoHashField
```
public CryptoHashField getCryptoHashField()
```
    Replace field value with a hash of that value. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
    
    Returns:
    
    value or null for none
  - setCryptoHashField
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata setCryptoHashField(CryptoHashField cryptoHashField)
```
    Replace field value with a hash of that value. Supported [types](https://www.hl7.org/fhir/datatypes.html): Code, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml.
    
    Parameters:
    
    cryptoHashField - cryptoHashField or null for none
  - getDateShiftField
```
public DateShiftField getDateShiftField()
```
    Shift the date by a randomized number of days. See [date shifting](https://cloud.google.com/dlp/docs/concepts-date-shifting) for more information. Supported [types](https://www.hl7.org/fhir/datatypes.html): Date, DateTime.
    
    Returns:
    
    value or null for none
  - setDateShiftField
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata setDateShiftField(DateShiftField dateShiftField)
```
    Shift the date by a randomized number of days. See [date shifting](https://cloud.google.com/dlp/docs/concepts-date-shifting) for more information. Supported [types](https://www.hl7.org/fhir/datatypes.html): Date, DateTime.
    
    Parameters:
    
    dateShiftField - dateShiftField or null for none
  - getKeepField
```
public KeepField getKeepField()
```
    Keep the field unchanged.
    
    Returns:
    
    value or null for none
  - setKeepField
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata setKeepField(KeepField keepField)
```
    Keep the field unchanged.
    
    Parameters:
    
    keepField - keepField or null for none
  - getPaths
```
public List<String> getPaths()
```
    List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR [type](https://www.hl7.org/fhir/datatypes.html) name. All types begin with an upper case letter. For example, the resource field `Patient.Address.city`, which uses a [string](https://www.hl7.org/fhir/datatypes- definitions.html#Address.city) type, can be matched by `Patient.Address.String`. Partial matching is supported. For example, `Patient.Address.city` can be matched by `Address.city` (with `Patient` omitted). Partial matching and type matching can be combined, for example `Patient.Address.city` can be matched by `Address.String`. For "choice" types (those defined in the FHIR spec with the format `field[x]`), use two separate components. For example, `deceasedAge.unit` is matched by `Deceased.Age.unit`. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for example `HumanName.given`, `HumanName.family`) can be omitted.
    
    Returns:
    
    value or null for none
  - setPaths
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata setPaths(List<String> paths)
```
    List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR [type](https://www.hl7.org/fhir/datatypes.html) name. All types begin with an upper case letter. For example, the resource field `Patient.Address.city`, which uses a [string](https://www.hl7.org/fhir/datatypes- definitions.html#Address.city) type, can be matched by `Patient.Address.String`. Partial matching is supported. For example, `Patient.Address.city` can be matched by `Address.city` (with `Patient` omitted). Partial matching and type matching can be combined, for example `Patient.Address.city` can be matched by `Address.String`. For "choice" types (those defined in the FHIR spec with the format `field[x]`), use two separate components. For example, `deceasedAge.unit` is matched by `Deceased.Age.unit`. The following types are supported: AdministrativeGenderCode, Base64Binary, Boolean, Code, Date, DateTime, Decimal, HumanName, Id, Instant, Integer, LanguageCode, Markdown, Oid, PositiveInt, String, UnsignedInt, Uri, Uuid, Xhtml. The sub-type for HumanName (for example `HumanName.given`, `HumanName.family`) can be omitted.
    
    Parameters:
    
    paths - paths or null for none
  - getRemoveField
```
public RemoveField getRemoveField()
```
    Remove the field.
    
    Returns:
    
    value or null for none
  - setRemoveField
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata setRemoveField(RemoveField removeField)
```
    Remove the field.
    
    Parameters:
    
    removeField - removeField or null for none
  - set
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata set(String fieldName,
                                                               Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudHealthcareV1beta1DeidentifyFieldMetadata

Method Detail

getCharacterMaskField

setCharacterMaskField

getCleanTextField

setCleanTextField

getCryptoHashField

setCryptoHashField

getDateShiftField

setDateShiftField

getKeepField

setKeepField

getPaths

setPaths

getRemoveField

setRemoveField

set

clone