Package com.google.privacy.dlp.v2

Class CustomInfoType.Dictionary

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.privacy.dlp.v2.CustomInfoType.Dictionary
All Implemented Interfaces:
CustomInfoType.DictionaryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
CustomInfoType
public static final class CustomInfoType.Dictionary extends com.google.protobuf.GeneratedMessage implements CustomInfoType.DictionaryOrBuilder
 Custom information type based on a dictionary of words or phrases. This can
 be used to match sensitive information specific to the data, such as a list
 of employee IDs or job titles.

 Dictionary words are case-insensitive and all characters other than letters
 and digits in the unicode [Basic Multilingual
 Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)
 will be replaced with whitespace when scanning for matches, so the
 dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",
 "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters
 surrounding any match must be of a different type than the adjacent
 characters within the word, so letters must be next to non-letters and
 digits next to non-digits. For example, the dictionary word "jen" will
 match the first three letters of the text "jen123" but will return no
 matches for "jennifer".

 Dictionary words containing a large number of characters that are not
 letters or digits may result in unexpected findings because such characters
 are treated as whitespace. The
 [limits](https://cloud.google.com/sensitive-data-protection/limits) page
 contains details about the size limits of dictionaries. For dictionaries
 that do not fit within these constraints, consider using
 `LargeCustomDictionaryConfig` in the `StoredInfoType` API.
Protobuf type google.privacy.dlp.v2.CustomInfoType.Dictionary
See Also:

  • Field Details

    • WORD_LIST_FIELD_NUMBER

      public static final int WORD_LIST_FIELD_NUMBER
      See Also:

    • CLOUD_STORAGE_PATH_FIELD_NUMBER

      public static final int CLOUD_STORAGE_PATH_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

    • getSourceCase

      public CustomInfoType.Dictionary.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface CustomInfoType.DictionaryOrBuilder

    • hasWordList

      public boolean hasWordList()
       List of words or phrases to search for.
      .google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;
      Specified by:
      hasWordList in interface CustomInfoType.DictionaryOrBuilder
      Returns:
      Whether the wordList field is set.

    • getWordList

      public CustomInfoType.Dictionary.WordList getWordList()
       List of words or phrases to search for.
      .google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;
      Specified by:
      getWordList in interface CustomInfoType.DictionaryOrBuilder
      Returns:
      The wordList.

    • getWordListOrBuilder

      public CustomInfoType.Dictionary.WordListOrBuilder getWordListOrBuilder()
       List of words or phrases to search for.
      .google.privacy.dlp.v2.CustomInfoType.Dictionary.WordList word_list = 1;
      Specified by:
      getWordListOrBuilder in interface CustomInfoType.DictionaryOrBuilder

    • hasCloudStoragePath

      public boolean hasCloudStoragePath()
       Newline-delimited file of words in Cloud Storage. Only a single file
 is accepted.
      .google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;
      Specified by:
      hasCloudStoragePath in interface CustomInfoType.DictionaryOrBuilder
      Returns:
      Whether the cloudStoragePath field is set.

    • getCloudStoragePath

      public CloudStoragePath getCloudStoragePath()
       Newline-delimited file of words in Cloud Storage. Only a single file
 is accepted.
      .google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;
      Specified by:
      getCloudStoragePath in interface CustomInfoType.DictionaryOrBuilder
      Returns:
      The cloudStoragePath.

    • getCloudStoragePathOrBuilder

      public CloudStoragePathOrBuilder getCloudStoragePathOrBuilder()
       Newline-delimited file of words in Cloud Storage. Only a single file
 is accepted.
      .google.privacy.dlp.v2.CloudStoragePath cloud_storage_path = 3;
      Specified by:
      getCloudStoragePathOrBuilder in interface CustomInfoType.DictionaryOrBuilder

    • 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.Dictionary parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static CustomInfoType.Dictionary 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.Dictionary parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CustomInfoType.Dictionary.Builder newBuilder()

    • newBuilder

      public static CustomInfoType.Dictionary.Builder newBuilder(CustomInfoType.Dictionary prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CustomInfoType.Dictionary getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CustomInfoType.Dictionary> 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.Dictionary getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder