Package com.google.privacy.dlp.v2

Class CustomInfoType.DetectionRule.HotwordRule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.privacy.dlp.v2.CustomInfoType.DetectionRule.HotwordRule
All Implemented Interfaces:
CustomInfoType.DetectionRule.HotwordRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
CustomInfoType.DetectionRule
public static final class CustomInfoType.DetectionRule.HotwordRule extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • HOTWORD_REGEX_FIELD_NUMBER

      public static final int HOTWORD_REGEX_FIELD_NUMBER
      See Also:

    • PROXIMITY_FIELD_NUMBER

      public static final int PROXIMITY_FIELD_NUMBER
      See Also:

    • LIKELIHOOD_ADJUSTMENT_FIELD_NUMBER

      public static final int LIKELIHOOD_ADJUSTMENT_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasHotwordRegex

      public boolean hasHotwordRegex()
       Regular expression pattern defining what qualifies as a hotword.
      .google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;
      Specified by:
      hasHotwordRegex in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder
      Returns:
      Whether the hotwordRegex field is set.

    • getHotwordRegex

      public CustomInfoType.Regex getHotwordRegex()
       Regular expression pattern defining what qualifies as a hotword.
      .google.privacy.dlp.v2.CustomInfoType.Regex hotword_regex = 1;
      Specified by:
      getHotwordRegex in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder
      Returns:
      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;
      Specified by:
      getHotwordRegexOrBuilder in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder

    • 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]
 (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).
      .google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;
      Specified by:
      hasProximity in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder
      Returns:
      Whether the proximity field is set.

    • 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]
 (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).
      .google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;
      Specified by:
      getProximity in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder
      Returns:
      The proximity.

    • 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]
 (https://cloud.google.com/sensitive-data-protection/docs/creating-custom-infotypes-likelihood#match-column-values).
      .google.privacy.dlp.v2.CustomInfoType.DetectionRule.Proximity proximity = 2;
      Specified by:
      getProximityOrBuilder in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder

    • hasLikelihoodAdjustment

      public boolean hasLikelihoodAdjustment()
       Likelihood adjustment to apply to all matching findings.
      .google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;
      Specified by:
      hasLikelihoodAdjustment in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder
      Returns:
      Whether the likelihoodAdjustment field is set.

    • getLikelihoodAdjustment

      public CustomInfoType.DetectionRule.LikelihoodAdjustment getLikelihoodAdjustment()
       Likelihood adjustment to apply to all matching findings.
      .google.privacy.dlp.v2.CustomInfoType.DetectionRule.LikelihoodAdjustment likelihood_adjustment = 3;
      Specified by:
      getLikelihoodAdjustment in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder
      Returns:
      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;
      Specified by:
      getLikelihoodAdjustmentOrBuilder in interface CustomInfoType.DetectionRule.HotwordRuleOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CustomInfoType.DetectionRule.HotwordRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CustomInfoType.DetectionRule.HotwordRule.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

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

    • newBuilder

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

    • toBuilder

      public CustomInfoType.DetectionRule.HotwordRule.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CustomInfoType.DetectionRule.HotwordRule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static CustomInfoType.DetectionRule.HotwordRule getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CustomInfoType.DetectionRule.HotwordRule> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public CustomInfoType.DetectionRule.HotwordRule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder