Class FieldTransformation.Builder (3.55.0)

public static final class FieldTransformation.Builder extends GeneratedMessageV3.Builder<FieldTransformation.Builder> implements FieldTransformationOrBuilder

The transformation to apply to the field.

Protobuf type google.privacy.dlp.v2.FieldTransformation

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllFields(Iterable<? extends FieldId> values)

public FieldTransformation.Builder addAllFields(Iterable<? extends FieldId> values)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.FieldId>
Returns
Type Description
FieldTransformation.Builder

addFields(FieldId value)

public FieldTransformation.Builder addFields(FieldId value)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value FieldId
Returns
Type Description
FieldTransformation.Builder

addFields(FieldId.Builder builderForValue)

public FieldTransformation.Builder addFields(FieldId.Builder builderForValue)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue FieldId.Builder
Returns
Type Description
FieldTransformation.Builder

addFields(int index, FieldId value)

public FieldTransformation.Builder addFields(int index, FieldId value)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value FieldId
Returns
Type Description
FieldTransformation.Builder

addFields(int index, FieldId.Builder builderForValue)

public FieldTransformation.Builder addFields(int index, FieldId.Builder builderForValue)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
FieldTransformation.Builder

addFieldsBuilder()

public FieldId.Builder addFieldsBuilder()

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldId.Builder

addFieldsBuilder(int index)

public FieldId.Builder addFieldsBuilder(int index)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FieldTransformation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FieldTransformation.Builder
Overrides

build()

public FieldTransformation build()
Returns
Type Description
FieldTransformation

buildPartial()

public FieldTransformation buildPartial()
Returns
Type Description
FieldTransformation

clear()

public FieldTransformation.Builder clear()
Returns
Type Description
FieldTransformation.Builder
Overrides

clearCondition()

public FieldTransformation.Builder clearCondition()

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Returns
Type Description
FieldTransformation.Builder

clearField(Descriptors.FieldDescriptor field)

public FieldTransformation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FieldTransformation.Builder
Overrides

clearFields()

public FieldTransformation.Builder clearFields()

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldTransformation.Builder

clearInfoTypeTransformations()

public FieldTransformation.Builder clearInfoTypeTransformations()

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Returns
Type Description
FieldTransformation.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public FieldTransformation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FieldTransformation.Builder
Overrides

clearPrimitiveTransformation()

public FieldTransformation.Builder clearPrimitiveTransformation()

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Returns
Type Description
FieldTransformation.Builder

clearTransformation()

public FieldTransformation.Builder clearTransformation()
Returns
Type Description
FieldTransformation.Builder

clone()

public FieldTransformation.Builder clone()
Returns
Type Description
FieldTransformation.Builder
Overrides

getCondition()

public RecordCondition getCondition()

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Returns
Type Description
RecordCondition

The condition.

getConditionBuilder()

public RecordCondition.Builder getConditionBuilder()

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Returns
Type Description
RecordCondition.Builder

getConditionOrBuilder()

public RecordConditionOrBuilder getConditionOrBuilder()

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Returns
Type Description
RecordConditionOrBuilder

getDefaultInstanceForType()

public FieldTransformation getDefaultInstanceForType()
Returns
Type Description
FieldTransformation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFields(int index)

public FieldId getFields(int index)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
FieldId

getFieldsBuilder(int index)

public FieldId.Builder getFieldsBuilder(int index)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
FieldId.Builder

getFieldsBuilderList()

public List<FieldId.Builder> getFieldsBuilderList()

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getFieldsCount()

public int getFieldsCount()

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getFieldsList()

public List<FieldId> getFieldsList()

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<FieldId>

getFieldsOrBuilder(int index)

public FieldIdOrBuilder getFieldsOrBuilder(int index)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
FieldIdOrBuilder

getFieldsOrBuilderList()

public List<? extends FieldIdOrBuilder> getFieldsOrBuilderList()

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.FieldIdOrBuilder>

getInfoTypeTransformations()

public InfoTypeTransformations getInfoTypeTransformations()

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Returns
Type Description
InfoTypeTransformations

The infoTypeTransformations.

getInfoTypeTransformationsBuilder()

public InfoTypeTransformations.Builder getInfoTypeTransformationsBuilder()

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Returns
Type Description
InfoTypeTransformations.Builder

getInfoTypeTransformationsOrBuilder()

public InfoTypeTransformationsOrBuilder getInfoTypeTransformationsOrBuilder()

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Returns
Type Description
InfoTypeTransformationsOrBuilder

getPrimitiveTransformation()

public PrimitiveTransformation getPrimitiveTransformation()

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Returns
Type Description
PrimitiveTransformation

The primitiveTransformation.

getPrimitiveTransformationBuilder()

public PrimitiveTransformation.Builder getPrimitiveTransformationBuilder()

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Returns
Type Description
PrimitiveTransformation.Builder

getPrimitiveTransformationOrBuilder()

public PrimitiveTransformationOrBuilder getPrimitiveTransformationOrBuilder()

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Returns
Type Description
PrimitiveTransformationOrBuilder

getTransformationCase()

public FieldTransformation.TransformationCase getTransformationCase()
Returns
Type Description
FieldTransformation.TransformationCase

hasCondition()

public boolean hasCondition()

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Returns
Type Description
boolean

Whether the condition field is set.

hasInfoTypeTransformations()

public boolean hasInfoTypeTransformations()

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Returns
Type Description
boolean

Whether the infoTypeTransformations field is set.

hasPrimitiveTransformation()

public boolean hasPrimitiveTransformation()

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Returns
Type Description
boolean

Whether the primitiveTransformation field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCondition(RecordCondition value)

public FieldTransformation.Builder mergeCondition(RecordCondition value)

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Parameter
Name Description
value RecordCondition
Returns
Type Description
FieldTransformation.Builder

mergeFrom(FieldTransformation other)

public FieldTransformation.Builder mergeFrom(FieldTransformation other)
Parameter
Name Description
other FieldTransformation
Returns
Type Description
FieldTransformation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FieldTransformation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FieldTransformation.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FieldTransformation.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FieldTransformation.Builder
Overrides

mergeInfoTypeTransformations(InfoTypeTransformations value)

public FieldTransformation.Builder mergeInfoTypeTransformations(InfoTypeTransformations value)

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Parameter
Name Description
value InfoTypeTransformations
Returns
Type Description
FieldTransformation.Builder

mergePrimitiveTransformation(PrimitiveTransformation value)

public FieldTransformation.Builder mergePrimitiveTransformation(PrimitiveTransformation value)

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Parameter
Name Description
value PrimitiveTransformation
Returns
Type Description
FieldTransformation.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FieldTransformation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FieldTransformation.Builder
Overrides

removeFields(int index)

public FieldTransformation.Builder removeFields(int index)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
FieldTransformation.Builder

setCondition(RecordCondition value)

public FieldTransformation.Builder setCondition(RecordCondition value)

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Parameter
Name Description
value RecordCondition
Returns
Type Description
FieldTransformation.Builder

setCondition(RecordCondition.Builder builderForValue)

public FieldTransformation.Builder setCondition(RecordCondition.Builder builderForValue)

Only apply the transformation if the condition evaluates to true for the given RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation.

Example Use Cases:

  • Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range.
  • Redact a field if the date of birth field is greater than 85.

.google.privacy.dlp.v2.RecordCondition condition = 3;

Parameter
Name Description
builderForValue RecordCondition.Builder
Returns
Type Description
FieldTransformation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FieldTransformation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FieldTransformation.Builder
Overrides

setFields(int index, FieldId value)

public FieldTransformation.Builder setFields(int index, FieldId value)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value FieldId
Returns
Type Description
FieldTransformation.Builder

setFields(int index, FieldId.Builder builderForValue)

public FieldTransformation.Builder setFields(int index, FieldId.Builder builderForValue)

Required. Input field(s) to apply the transformation to. When you have columns that reference their position within a list, omit the index from the FieldId. FieldId name matching ignores the index. For example, instead of "contact.nums[0].type", use "contact.nums.type".

repeated .google.privacy.dlp.v2.FieldId fields = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue FieldId.Builder
Returns
Type Description
FieldTransformation.Builder

setInfoTypeTransformations(InfoTypeTransformations value)

public FieldTransformation.Builder setInfoTypeTransformations(InfoTypeTransformations value)

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Parameter
Name Description
value InfoTypeTransformations
Returns
Type Description
FieldTransformation.Builder

setInfoTypeTransformations(InfoTypeTransformations.Builder builderForValue)

public FieldTransformation.Builder setInfoTypeTransformations(InfoTypeTransformations.Builder builderForValue)

Treat the contents of the field as free text, and selectively transform content that matches an InfoType.

.google.privacy.dlp.v2.InfoTypeTransformations info_type_transformations = 5;

Parameter
Name Description
builderForValue InfoTypeTransformations.Builder
Returns
Type Description
FieldTransformation.Builder

setPrimitiveTransformation(PrimitiveTransformation value)

public FieldTransformation.Builder setPrimitiveTransformation(PrimitiveTransformation value)

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Parameter
Name Description
value PrimitiveTransformation
Returns
Type Description
FieldTransformation.Builder

setPrimitiveTransformation(PrimitiveTransformation.Builder builderForValue)

public FieldTransformation.Builder setPrimitiveTransformation(PrimitiveTransformation.Builder builderForValue)

Apply the transformation to the entire field.

.google.privacy.dlp.v2.PrimitiveTransformation primitive_transformation = 4;

Parameter
Name Description
builderForValue PrimitiveTransformation.Builder
Returns
Type Description
FieldTransformation.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FieldTransformation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FieldTransformation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FieldTransformation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FieldTransformation.Builder
Overrides