/*
 * 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/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.contentwarehouse.v1.model;

/**
 * A mention of an entity. A single entity might be mentioned multiple times.
 *
 * <p> 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 Document AI Warehouse API. For a detailed explanation
 * see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class NlxDataSchemaMention extends com.google.api.client.json.GenericJson {

  /**
   * The bytes in this mention.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private MultiscalePointerSpan bytes;

  /**
   * The document that contains this mention.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private MultiscalePointerIndex document;

  /**
   * The entity that this mention refers to.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private MultiscalePointerIndex entity;

  /**
   * Mention kind, typically 'referential', 'attributive', or 'modifier'.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kind;

  /**
   * The mention text itself. Must contain valid UTF-8.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String text;

  /**
   * The token(s) in this mention. This may not be present, or have zero length if representing an
   * implicit mention, as in the prodrop case.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private MultiscalePointerSpan tokens;

  /**
   * Mention type, typically 'named' (for name mentions) or 'nominal'. More types include
   * 'pronominal', 'conjoined' for conjoined mention construction, and 'non-referential' for non-
   * referential pronoun mentions.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * The bytes in this mention.
   * @return value or {@code null} for none
   */
  public MultiscalePointerSpan getBytes() {
    return bytes;
  }

  /**
   * The bytes in this mention.
   * @param bytes bytes or {@code null} for none
   */
  public NlxDataSchemaMention setBytes(MultiscalePointerSpan bytes) {
    this.bytes = bytes;
    return this;
  }

  /**
   * The document that contains this mention.
   * @return value or {@code null} for none
   */
  public MultiscalePointerIndex getDocument() {
    return document;
  }

  /**
   * The document that contains this mention.
   * @param document document or {@code null} for none
   */
  public NlxDataSchemaMention setDocument(MultiscalePointerIndex document) {
    this.document = document;
    return this;
  }

  /**
   * The entity that this mention refers to.
   * @return value or {@code null} for none
   */
  public MultiscalePointerIndex getEntity() {
    return entity;
  }

  /**
   * The entity that this mention refers to.
   * @param entity entity or {@code null} for none
   */
  public NlxDataSchemaMention setEntity(MultiscalePointerIndex entity) {
    this.entity = entity;
    return this;
  }

  /**
   * Mention kind, typically 'referential', 'attributive', or 'modifier'.
   * @return value or {@code null} for none
   */
  public java.lang.String getKind() {
    return kind;
  }

  /**
   * Mention kind, typically 'referential', 'attributive', or 'modifier'.
   * @param kind kind or {@code null} for none
   */
  public NlxDataSchemaMention setKind(java.lang.String kind) {
    this.kind = kind;
    return this;
  }

  /**
   * The mention text itself. Must contain valid UTF-8.
   * @return value or {@code null} for none
   */
  public java.lang.String getText() {
    return text;
  }

  /**
   * The mention text itself. Must contain valid UTF-8.
   * @param text text or {@code null} for none
   */
  public NlxDataSchemaMention setText(java.lang.String text) {
    this.text = text;
    return this;
  }

  /**
   * The token(s) in this mention. This may not be present, or have zero length if representing an
   * implicit mention, as in the prodrop case.
   * @return value or {@code null} for none
   */
  public MultiscalePointerSpan getTokens() {
    return tokens;
  }

  /**
   * The token(s) in this mention. This may not be present, or have zero length if representing an
   * implicit mention, as in the prodrop case.
   * @param tokens tokens or {@code null} for none
   */
  public NlxDataSchemaMention setTokens(MultiscalePointerSpan tokens) {
    this.tokens = tokens;
    return this;
  }

  /**
   * Mention type, typically 'named' (for name mentions) or 'nominal'. More types include
   * 'pronominal', 'conjoined' for conjoined mention construction, and 'non-referential' for non-
   * referential pronoun mentions.
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * Mention type, typically 'named' (for name mentions) or 'nominal'. More types include
   * 'pronominal', 'conjoined' for conjoined mention construction, and 'non-referential' for non-
   * referential pronoun mentions.
   * @param type type or {@code null} for none
   */
  public NlxDataSchemaMention setType(java.lang.String type) {
    this.type = type;
    return this;
  }

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

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

}
