/*
 * 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 VideoContentSearchDescriptionAnchorFeatures.
 *
 * <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 VideoContentSearchDescriptionAnchorFeatures extends com.google.api.client.json.GenericJson {

  /**
   * When the description anchor text has been recognized as an entity, how much of the description
   * anchor text is covered by the entity mention.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float entityTextCoverage;

  /**
   * Whether or not a mention of the description anchor exists in the ASR.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean inAsr;

  /**
   * Whether or not the anchor was created from the description for use in training data. This will
   * be set to true for positive examples and false for negative examples.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isDescriptionAnchor;

  /**
   * The distance from the ASR sentence to the description anchor time in ms.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer spanToAsrTime;

  /**
   * When the description anchor text has been recognized as an entity, how much of the description
   * anchor text is covered by the entity mention.
   * @return value or {@code null} for none
   */
  public java.lang.Float getEntityTextCoverage() {
    return entityTextCoverage;
  }

  /**
   * When the description anchor text has been recognized as an entity, how much of the description
   * anchor text is covered by the entity mention.
   * @param entityTextCoverage entityTextCoverage or {@code null} for none
   */
  public VideoContentSearchDescriptionAnchorFeatures setEntityTextCoverage(java.lang.Float entityTextCoverage) {
    this.entityTextCoverage = entityTextCoverage;
    return this;
  }

  /**
   * Whether or not a mention of the description anchor exists in the ASR.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getInAsr() {
    return inAsr;
  }

  /**
   * Whether or not a mention of the description anchor exists in the ASR.
   * @param inAsr inAsr or {@code null} for none
   */
  public VideoContentSearchDescriptionAnchorFeatures setInAsr(java.lang.Boolean inAsr) {
    this.inAsr = inAsr;
    return this;
  }

  /**
   * Whether or not the anchor was created from the description for use in training data. This will
   * be set to true for positive examples and false for negative examples.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsDescriptionAnchor() {
    return isDescriptionAnchor;
  }

  /**
   * Whether or not the anchor was created from the description for use in training data. This will
   * be set to true for positive examples and false for negative examples.
   * @param isDescriptionAnchor isDescriptionAnchor or {@code null} for none
   */
  public VideoContentSearchDescriptionAnchorFeatures setIsDescriptionAnchor(java.lang.Boolean isDescriptionAnchor) {
    this.isDescriptionAnchor = isDescriptionAnchor;
    return this;
  }

  /**
   * The distance from the ASR sentence to the description anchor time in ms.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getSpanToAsrTime() {
    return spanToAsrTime;
  }

  /**
   * The distance from the ASR sentence to the description anchor time in ms.
   * @param spanToAsrTime spanToAsrTime or {@code null} for none
   */
  public VideoContentSearchDescriptionAnchorFeatures setSpanToAsrTime(java.lang.Integer spanToAsrTime) {
    this.spanToAsrTime = spanToAsrTime;
    return this;
  }

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

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

}
