Class CustomInfoType.DetectionRule.HotwordRule (3.57.0)

public static final class CustomInfoType.DetectionRule.HotwordRule extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CustomInfoType.DetectionRule.HotwordRule

Implements

CustomInfoType.DetectionRule.HotwordRuleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

HOTWORD_REGEX_FIELD_NUMBER

public static final int HOTWORD_REGEX_FIELD_NUMBER

Field Value
Type	Description
`int`

LIKELIHOOD_ADJUSTMENT_FIELD_NUMBER

public static final int LIKELIHOOD_ADJUSTMENT_FIELD_NUMBER

Field Value
Type	Description
`int`

PROXIMITY_FIELD_NUMBER

public static final int PROXIMITY_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static CustomInfoType.DetectionRule.HotwordRule getDefaultInstance()

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static CustomInfoType.DetectionRule.HotwordRule.Builder newBuilder()

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule.Builder`

newBuilder(CustomInfoType.DetectionRule.HotwordRule prototype)

public static CustomInfoType.DetectionRule.HotwordRule.Builder newBuilder(CustomInfoType.DetectionRule.HotwordRule prototype)

Parameter
Name	Description
`prototype`	`CustomInfoType.DetectionRule.HotwordRule`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule.Builder`

parseDelimitedFrom(InputStream input)

public static CustomInfoType.DetectionRule.HotwordRule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.DetectionRule.HotwordRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CustomInfoType.DetectionRule.HotwordRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<CustomInfoType.DetectionRule.HotwordRule> parser()

Returns
Type	Description
`Parser<HotwordRule>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public CustomInfoType.DetectionRule.HotwordRule getDefaultInstanceForType()

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule`

getHotwordRegex()

public CustomInfoType.Regex getHotwordRegex()

Regular expression pattern defining what qualifies as a hotword.

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

Returns
Type	Description
`CustomInfoType.Regex`	The hotwordRegex.

getHotwordRegexOrBuilder()

public CustomInfoType.RegexOrBuilder getHotwordRegexOrBuilder()

Regular expression pattern defining what qualifies as a hotword.

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

Returns
Type	Description
`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
Type	Description
`CustomInfoType.DetectionRule.LikelihoodAdjustment`	The likelihoodAdjustment.

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
Type	Description
`CustomInfoType.DetectionRule.LikelihoodAdjustmentOrBuilder`

getParserForType()

public Parser<CustomInfoType.DetectionRule.HotwordRule> getParserForType()

Returns
Type	Description
`Parser<HotwordRule>`

Overrides

GeneratedMessageV3.getParserForType()

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
Type	Description
`CustomInfoType.DetectionRule.Proximity`	The proximity.

getProximityOrBuilder()

public CustomInfoType.DetectionRule.ProximityOrBuilder getProximityOrBuilder()

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
Type	Description
`CustomInfoType.DetectionRule.ProximityOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hasHotwordRegex()

public boolean hasHotwordRegex()

Regular expression pattern defining what qualifies as a hotword.

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

Returns
Type	Description
`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
Type	Description
`boolean`	Whether the likelihoodAdjustment field is set.

hasProximity()

public boolean hasProximity()

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
Type	Description
`boolean`	Whether the proximity field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public CustomInfoType.DetectionRule.HotwordRule.Builder newBuilderForType()

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CustomInfoType.DetectionRule.HotwordRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public CustomInfoType.DetectionRule.HotwordRule.Builder toBuilder()

Returns
Type	Description
`CustomInfoType.DetectionRule.HotwordRule.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`