com.google.api.services.dlp.v2beta1.model.GooglePrivacyDlpV2beta1Dictionary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dlp Show documentation
There is a newer version: v2-rev20241215-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
/*
 * This code was generated by https://github.com/google/apis-client-generator/
 * (build: 2017-11-07 19:12:12 UTC)
 * on 2018-01-18 at 22:50:57 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.dlp.v2beta1.model;

/**
 * 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.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the DLP API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GooglePrivacyDlpV2beta1Dictionary extends com.google.api.client.json.GenericJson {

  /**
   * List of words or phrases to search for.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GooglePrivacyDlpV2beta1WordList wordList;

  /**
   * List of words or phrases to search for.
   * @return value or {@code null} for none
   */
  public GooglePrivacyDlpV2beta1WordList getWordList() {
    return wordList;
  }

  /**
   * List of words or phrases to search for.
   * @param wordList wordList or {@code null} for none
   */
  public GooglePrivacyDlpV2beta1Dictionary setWordList(GooglePrivacyDlpV2beta1WordList wordList) {
    this.wordList = wordList;
    return this;
  }

  @Override
  public GooglePrivacyDlpV2beta1Dictionary set(String fieldName, Object value) {
    return (GooglePrivacyDlpV2beta1Dictionary) super.set(fieldName, value);
  }

  @Override
  public GooglePrivacyDlpV2beta1Dictionary clone() {
    return (GooglePrivacyDlpV2beta1Dictionary) super.clone();
  }

}