Class CustomInfoType.DetectionRule.HotwordRule (3.80.0) 
  
  
  
   
  
    
  
  
    
    
    
    
    
  Version latestkeyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
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
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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 ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule . Builder   newBuilder ()  
  
  newBuilder(CustomInfoType.DetectionRule.HotwordRule prototype) 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule . Builder   newBuilder ( CustomInfoType . DetectionRule . HotwordRule   prototype )  
  
  
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   CustomInfoType . DetectionRule . HotwordRule   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<CustomInfoType . DetectionRule . HotwordRule >  parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getDefaultInstanceForType() 
  
    
public   CustomInfoType . DetectionRule . HotwordRule   getDefaultInstanceForType ()  
  
  getHotwordRegex() 
  
    
public   CustomInfoType . Regex   getHotwordRegex ()  
   Regular expression pattern defining what qualifies as a hotword.
 .google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;
getHotwordRegexOrBuilder() 
  
    
public   CustomInfoType . RegexOrBuilder   getHotwordRegexOrBuilder ()  
   Regular expression pattern defining what qualifies as a hotword.
 .google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;
getLikelihoodAdjustment() 
  
    
public   CustomInfoType . DetectionRule . LikelihoodAdjustment   getLikelihoodAdjustment ()  
   Likelihood adjustment to apply to all matching findings.
 
 .google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;
 
getLikelihoodAdjustmentOrBuilder() 
  
    
public   CustomInfoType . DetectionRule . LikelihoodAdjustmentOrBuilder   getLikelihoodAdjustmentOrBuilder ()  
   Likelihood adjustment to apply to all matching findings.
 
 .google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;
 
getParserForType() 
  
    
public   Parser<CustomInfoType . DetectionRule . HotwordRule >  getParserForType ()  
  
  Overrides 
  
  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;
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;
getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  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 ()  
   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  
      
        boolean Whether the proximity field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   CustomInfoType . DetectionRule . HotwordRule . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   CustomInfoType . DetectionRule . HotwordRule . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   CustomInfoType . DetectionRule . HotwordRule . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-11 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]