/*
 * 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;

/**
 * Model definition for SentenceBoundaryAnnotationsInstance.
 *
 * <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 SentenceBoundaryAnnotationsInstance extends com.google.api.client.json.GenericJson {

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer begin;

  /**
   * A clean version of .text() generated by using CleanText() and stripping unnecessary whitespace.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String cleanText;

  /**
   * Plain text context from the page within which the annotation occurred.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String context;

  /**
   * Byte offsets for the clean text context above.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer contextBegin;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer contextEnd;

  /**
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer end;

  /**
   * Used for application-specific information about this annotation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Proto2BridgeMessageSet info;

  /**
   * Original UTF-8 document text occurring in the range [begin, end).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String text;

  /**
   * Used to mark the annotations selected to be indexed.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean toIndex;

  /**
   * @return value or {@code null} for none
   */
  public java.lang.Integer getBegin() {
    return begin;
  }

  /**
   * @param begin begin or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setBegin(java.lang.Integer begin) {
    this.begin = begin;
    return this;
  }

  /**
   * A clean version of .text() generated by using CleanText() and stripping unnecessary whitespace.
   * @return value or {@code null} for none
   */
  public java.lang.String getCleanText() {
    return cleanText;
  }

  /**
   * A clean version of .text() generated by using CleanText() and stripping unnecessary whitespace.
   * @param cleanText cleanText or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setCleanText(java.lang.String cleanText) {
    this.cleanText = cleanText;
    return this;
  }

  /**
   * Plain text context from the page within which the annotation occurred.
   * @return value or {@code null} for none
   */
  public java.lang.String getContext() {
    return context;
  }

  /**
   * Plain text context from the page within which the annotation occurred.
   * @param context context or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setContext(java.lang.String context) {
    this.context = context;
    return this;
  }

  /**
   * Byte offsets for the clean text context above.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getContextBegin() {
    return contextBegin;
  }

  /**
   * Byte offsets for the clean text context above.
   * @param contextBegin contextBegin or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setContextBegin(java.lang.Integer contextBegin) {
    this.contextBegin = contextBegin;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.lang.Integer getContextEnd() {
    return contextEnd;
  }

  /**
   * @param contextEnd contextEnd or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setContextEnd(java.lang.Integer contextEnd) {
    this.contextEnd = contextEnd;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.lang.Integer getEnd() {
    return end;
  }

  /**
   * @param end end or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setEnd(java.lang.Integer end) {
    this.end = end;
    return this;
  }

  /**
   * Used for application-specific information about this annotation.
   * @return value or {@code null} for none
   */
  public Proto2BridgeMessageSet getInfo() {
    return info;
  }

  /**
   * Used for application-specific information about this annotation.
   * @param info info or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setInfo(Proto2BridgeMessageSet info) {
    this.info = info;
    return this;
  }

  /**
   * Original UTF-8 document text occurring in the range [begin, end).
   * @return value or {@code null} for none
   */
  public java.lang.String getText() {
    return text;
  }

  /**
   * Original UTF-8 document text occurring in the range [begin, end).
   * @param text text or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setText(java.lang.String text) {
    this.text = text;
    return this;
  }

  /**
   * Used to mark the annotations selected to be indexed.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getToIndex() {
    return toIndex;
  }

  /**
   * Used to mark the annotations selected to be indexed.
   * @param toIndex toIndex or {@code null} for none
   */
  public SentenceBoundaryAnnotationsInstance setToIndex(java.lang.Boolean toIndex) {
    this.toIndex = toIndex;
    return this;
  }

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

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

}
