Class ExcludeByHotword (3.20.0) 
  
      
     
  
  
  
   
  
    
  
  
    
    
    
  Version 3.20.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  ExcludeByHotword   extends   GeneratedMessageV3   implements   ExcludeByHotwordOrBuilder  
   
   The rule to exclude findings based on a hotword. For record inspection of
 tables, column names are considered hotwords. An example of this is to
 exclude a finding if a BigQuery column matches a specific pattern.
 Protobuf type google.privacy.dlp.v2.ExcludeByHotword
 
  
  
  
  Static Fields
   
  HOTWORD_REGEX_FIELD_NUMBER 
  
    
public   static   final   int   HOTWORD_REGEX_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   ExcludeByHotword   getDefaultInstance ()  
   
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  
   
  newBuilder() 
  
    
public   static   ExcludeByHotword . Builder   newBuilder ()  
   
  
   
  newBuilder(ExcludeByHotword prototype) 
  
    
public   static   ExcludeByHotword . Builder   newBuilder ( ExcludeByHotword   prototype )  
   
  
  
   
  
  
    
public   static   ExcludeByHotword   parseDelimitedFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   ExcludeByHotword   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(byte[] data) 
  
    
public   static   ExcludeByHotword   parseFrom ( byte []   data )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ExcludeByHotword   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteString data) 
  
    
public   static   ExcludeByHotword   parseFrom ( ByteString   data )  
   
  
  
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ExcludeByHotword   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   ExcludeByHotword   parseFrom ( CodedInputStream   input )  
   
  
  
  
   
  
  
    
public   static   ExcludeByHotword   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  
  
    
public   static   ExcludeByHotword   parseFrom ( InputStream   input )  
   
  
  
  
   
  
  
    
public   static   ExcludeByHotword   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   ExcludeByHotword   parseFrom ( ByteBuffer   data )  
   
  
  
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   ExcludeByHotword   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  
  
  
   
  parser() 
  
    
public   static   Parser<ExcludeByHotword>   parser ()  
   
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  
    
      
        Parameter  
       
      
        Name  
        Description  
       
      
        obj 
        Object  
       
     
  
  
  Overrides 
  
   
  getDefaultInstanceForType() 
  
    
public   ExcludeByHotword   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;
 
  
   
  getParserForType() 
  
    
public   Parser<ExcludeByHotword>   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 windowBefore property in proximity should be set to 1 if the hotword
 needs to be included in a column header.
 .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 windowBefore property in proximity should be set to 1 if the hotword
 needs to be included in a column header.
 .google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;
 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        int  
         
       
     
  
  Overrides 
  
   
  getUnknownFields() 
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
   
  
  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.
 
       
     
  
   
  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 windowBefore property in proximity should be set to 1 if the hotword
 needs to be included in a column header.
 .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   ExcludeByHotword . Builder   newBuilderForType ()  
   
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   ExcludeByHotword . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  
  
    
      
        Returns  
       
      
        Type  
        Description  
       
      
        Object  
         
       
     
  
  Overrides 
  
   
  toBuilder() 
  
    
public   ExcludeByHotword . 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-30 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]