Class CustomInfoType.DetectionRule.HotwordRule.Builder (3.31.0)

public static final class CustomInfoType.DetectionRule.HotwordRule.Builder extends GeneratedMessageV3.Builder<CustomInfoType.DetectionRule.HotwordRule.Builder> implements CustomInfoType.DetectionRule.HotwordRuleOrBuilder

The rule that adjusts the likelihood of findings within a certain proximity of hotwords.

Protobuf type google.privacy.dlp.v2.CustomInfoType.DetectionRule.HotwordRule

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CustomInfoType.DetectionRule.HotwordRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

build()

public CustomInfoType.DetectionRule.HotwordRule build()
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule

buildPartial()

public CustomInfoType.DetectionRule.HotwordRule buildPartial()
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule

clear()

public CustomInfoType.DetectionRule.HotwordRule.Builder clear()
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public CustomInfoType.DetectionRule.HotwordRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

clearHotwordRegex()

public CustomInfoType.DetectionRule.HotwordRule.Builder clearHotwordRegex()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

clearLikelihoodAdjustment()

public CustomInfoType.DetectionRule.HotwordRule.Builder clearLikelihoodAdjustment()

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public CustomInfoType.DetectionRule.HotwordRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

clearProximity()

public CustomInfoType.DetectionRule.HotwordRule.Builder clearProximity()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

clone()

public CustomInfoType.DetectionRule.HotwordRule.Builder clone()
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

getDefaultInstanceForType()

public CustomInfoType.DetectionRule.HotwordRule getDefaultInstanceForType()
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHotwordRegex()

public CustomInfoType.Regex getHotwordRegex()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
CustomInfoType.Regex

The hotwordRegex.

getHotwordRegexBuilder()

public CustomInfoType.Regex.Builder getHotwordRegexBuilder()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
CustomInfoType.Regex.Builder

getHotwordRegexOrBuilder()

public CustomInfoType.RegexOrBuilder getHotwordRegexOrBuilder()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
CustomInfoType.RegexOrBuilder

getLikelihoodAdjustment()

public CustomInfoType.DetectionRule.LikelihoodAdjustment getLikelihoodAdjustment()

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Returns
TypeDescription
CustomInfoType.DetectionRule.LikelihoodAdjustment

The likelihoodAdjustment.

getLikelihoodAdjustmentBuilder()

public CustomInfoType.DetectionRule.LikelihoodAdjustment.Builder getLikelihoodAdjustmentBuilder()

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Returns
TypeDescription
CustomInfoType.DetectionRule.LikelihoodAdjustment.Builder

getLikelihoodAdjustmentOrBuilder()

public CustomInfoType.DetectionRule.LikelihoodAdjustmentOrBuilder getLikelihoodAdjustmentOrBuilder()

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Returns
TypeDescription
CustomInfoType.DetectionRule.LikelihoodAdjustmentOrBuilder

getProximity()

public CustomInfoType.DetectionRule.Proximity getProximity()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
CustomInfoType.DetectionRule.Proximity

The proximity.

getProximityBuilder()

public CustomInfoType.DetectionRule.Proximity.Builder getProximityBuilder()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
CustomInfoType.DetectionRule.Proximity.Builder

getProximityOrBuilder()

public CustomInfoType.DetectionRule.ProximityOrBuilder getProximityOrBuilder()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
CustomInfoType.DetectionRule.ProximityOrBuilder

hasHotwordRegex()

public boolean hasHotwordRegex()

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Returns
TypeDescription
boolean

Whether the hotwordRegex field is set.

hasLikelihoodAdjustment()

public boolean hasLikelihoodAdjustment()

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Returns
TypeDescription
boolean

Whether the likelihoodAdjustment field is set.

hasProximity()

public boolean hasProximity()

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Returns
TypeDescription
boolean

Whether the proximity field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CustomInfoType.DetectionRule.HotwordRule other)

public CustomInfoType.DetectionRule.HotwordRule.Builder mergeFrom(CustomInfoType.DetectionRule.HotwordRule other)
Parameter
NameDescription
otherCustomInfoType.DetectionRule.HotwordRule
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CustomInfoType.DetectionRule.HotwordRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public CustomInfoType.DetectionRule.HotwordRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

mergeHotwordRegex(CustomInfoType.Regex value)

public CustomInfoType.DetectionRule.HotwordRule.Builder mergeHotwordRegex(CustomInfoType.Regex value)

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Parameter
NameDescription
valueCustomInfoType.Regex
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

mergeLikelihoodAdjustment(CustomInfoType.DetectionRule.LikelihoodAdjustment value)

public CustomInfoType.DetectionRule.HotwordRule.Builder mergeLikelihoodAdjustment(CustomInfoType.DetectionRule.LikelihoodAdjustment value)

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Parameter
NameDescription
valueCustomInfoType.DetectionRule.LikelihoodAdjustment
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

mergeProximity(CustomInfoType.DetectionRule.Proximity value)

public CustomInfoType.DetectionRule.HotwordRule.Builder mergeProximity(CustomInfoType.DetectionRule.Proximity value)

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Parameter
NameDescription
valueCustomInfoType.DetectionRule.Proximity
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CustomInfoType.DetectionRule.HotwordRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public CustomInfoType.DetectionRule.HotwordRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

setHotwordRegex(CustomInfoType.Regex value)

public CustomInfoType.DetectionRule.HotwordRule.Builder setHotwordRegex(CustomInfoType.Regex value)

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Parameter
NameDescription
valueCustomInfoType.Regex
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

setHotwordRegex(CustomInfoType.Regex.Builder builderForValue)

public CustomInfoType.DetectionRule.HotwordRule.Builder setHotwordRegex(CustomInfoType.Regex.Builder builderForValue)

Regular expression pattern defining what qualifies as a hotword.

.google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;

Parameter
NameDescription
builderForValueCustomInfoType.Regex.Builder
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

setLikelihoodAdjustment(CustomInfoType.DetectionRule.LikelihoodAdjustment value)

public CustomInfoType.DetectionRule.HotwordRule.Builder setLikelihoodAdjustment(CustomInfoType.DetectionRule.LikelihoodAdjustment value)

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Parameter
NameDescription
valueCustomInfoType.DetectionRule.LikelihoodAdjustment
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

setLikelihoodAdjustment(CustomInfoType.DetectionRule.LikelihoodAdjustment.Builder builderForValue)

public CustomInfoType.DetectionRule.HotwordRule.Builder setLikelihoodAdjustment(CustomInfoType.DetectionRule.LikelihoodAdjustment.Builder builderForValue)

Likelihood adjustment to apply to all matching findings.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;

Parameter
NameDescription
builderForValueCustomInfoType.DetectionRule.LikelihoodAdjustment.Builder
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

setProximity(CustomInfoType.DetectionRule.Proximity value)

public CustomInfoType.DetectionRule.HotwordRule.Builder setProximity(CustomInfoType.DetectionRule.Proximity value)

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Parameter
NameDescription
valueCustomInfoType.DetectionRule.Proximity
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

setProximity(CustomInfoType.DetectionRule.Proximity.Builder builderForValue)

public CustomInfoType.DetectionRule.HotwordRule.Builder setProximity(CustomInfoType.DetectionRule.Proximity.Builder builderForValue)

Range of characters within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. The finding itself will be included in the window, so that hotwords can be used to match substrings of the finding itself. Suppose you want Cloud DLP to promote the likelihood of the phone number regex "\(\d{3}\) \d{3}-\d{4}" if the area code is known to be the area code of a company's office. In this case, use the hotword regex "\(xxx\)", where "xxx" is the area code in question.

For tabular data, if you want to modify the likelihood of an entire column of findngs, see Hotword example: Set the match likelihood of a table column.

.google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;

Parameter
NameDescription
builderForValueCustomInfoType.DetectionRule.Proximity.Builder
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder

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

public CustomInfoType.DetectionRule.HotwordRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final CustomInfoType.DetectionRule.HotwordRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
CustomInfoType.DetectionRule.HotwordRule.Builder
Overrides