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

/**
 * Token by token mapping between hypothesis text and reference text.
 *
 * <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 VideoContentSearchTokenAlignment extends com.google.api.client.json.GenericJson {

  /**
   * Index of the token in hypothesis text.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer hypothesisIndex;

  /**
   * Token in hypothesis.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String hypothesisToken;

  /**
   * Index of the word in reference.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer referenceIndex;

  /**
   * Token in label.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String referenceToken;

  /**
   * Whether it's a perfect match.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean tokenIsMatched;

  /**
   * Index of the token in hypothesis text.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getHypothesisIndex() {
    return hypothesisIndex;
  }

  /**
   * Index of the token in hypothesis text.
   * @param hypothesisIndex hypothesisIndex or {@code null} for none
   */
  public VideoContentSearchTokenAlignment setHypothesisIndex(java.lang.Integer hypothesisIndex) {
    this.hypothesisIndex = hypothesisIndex;
    return this;
  }

  /**
   * Token in hypothesis.
   * @return value or {@code null} for none
   */
  public java.lang.String getHypothesisToken() {
    return hypothesisToken;
  }

  /**
   * Token in hypothesis.
   * @param hypothesisToken hypothesisToken or {@code null} for none
   */
  public VideoContentSearchTokenAlignment setHypothesisToken(java.lang.String hypothesisToken) {
    this.hypothesisToken = hypothesisToken;
    return this;
  }

  /**
   * Index of the word in reference.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getReferenceIndex() {
    return referenceIndex;
  }

  /**
   * Index of the word in reference.
   * @param referenceIndex referenceIndex or {@code null} for none
   */
  public VideoContentSearchTokenAlignment setReferenceIndex(java.lang.Integer referenceIndex) {
    this.referenceIndex = referenceIndex;
    return this;
  }

  /**
   * Token in label.
   * @return value or {@code null} for none
   */
  public java.lang.String getReferenceToken() {
    return referenceToken;
  }

  /**
   * Token in label.
   * @param referenceToken referenceToken or {@code null} for none
   */
  public VideoContentSearchTokenAlignment setReferenceToken(java.lang.String referenceToken) {
    this.referenceToken = referenceToken;
    return this;
  }

  /**
   * Whether it's a perfect match.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getTokenIsMatched() {
    return tokenIsMatched;
  }

  /**
   * Whether it's a perfect match.
   * @param tokenIsMatched tokenIsMatched or {@code null} for none
   */
  public VideoContentSearchTokenAlignment setTokenIsMatched(java.lang.Boolean tokenIsMatched) {
    this.tokenIsMatched = tokenIsMatched;
    return this;
  }

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

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

}
