/*
 * 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 single sentence or utterance.
 *
 * <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 NlxDataSchemaSentence extends com.google.api.client.json.GenericJson {

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

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

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

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

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

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

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

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

  /**
   * The characters in this sentence.
   * @return value or {@code null} for none
   */
  public MultiscalePointerSpan getCharacters() {
    return characters;
  }

  /**
   * The characters in this sentence.
   * @param characters characters or {@code null} for none
   */
  public NlxDataSchemaSentence setCharacters(MultiscalePointerSpan characters) {
    this.characters = characters;
    return this;
  }

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

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

  /**
   * The paragraph that contains this sentence.
   * @return value or {@code null} for none
   */
  public MultiscalePointerIndex getParagraph() {
    return paragraph;
  }

  /**
   * The paragraph that contains this sentence.
   * @param paragraph paragraph or {@code null} for none
   */
  public NlxDataSchemaSentence setParagraph(MultiscalePointerIndex paragraph) {
    this.paragraph = paragraph;
    return this;
  }

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

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

  /**
   * The tokens in this sentence.
   * @return value or {@code null} for none
   */
  public MultiscalePointerSpan getTokens() {
    return tokens;
  }

  /**
   * The tokens in this sentence.
   * @param tokens tokens or {@code null} for none
   */
  public NlxDataSchemaSentence setTokens(MultiscalePointerSpan tokens) {
    this.tokens = tokens;
    return this;
  }

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

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

}
