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

/**
 * Saft named-entities info for a given topic.
 *
 * <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 VideoContentSearchSaftEntityInfo extends com.google.api.client.json.GenericJson {

  /**
   * Representative canonical name for the entity.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String canonicalEntityName;

  /**
   * Score indicating the saliency (centrality) of this entity to the original_text.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Double entitySalience;

  /**
   * The type name, like "/saft/person", "/saft/art". See README.entity-types for the inventory of
   * SAFT type tags.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String entityTypeName;

  /**
   * Representative entity name mention extracted from original_text.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String mentionText;

  /**
   * SAFT Mention type.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String mentionType;

  /**
   * Freebase MID for entity if this the saft entity corresponds to a Webref KG mid. This field is
   * not always populated and is taken from FREEBASE_MID mid in EntityProfile in the saft entity
   * annotation.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String mid;

  /**
   * The original input text (e.g. the anchor text) where the saft entity annotation was run on.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String originalText;

  /**
   * Representative canonical name for the entity.
   * @return value or {@code null} for none
   */
  public java.lang.String getCanonicalEntityName() {
    return canonicalEntityName;
  }

  /**
   * Representative canonical name for the entity.
   * @param canonicalEntityName canonicalEntityName or {@code null} for none
   */
  public VideoContentSearchSaftEntityInfo setCanonicalEntityName(java.lang.String canonicalEntityName) {
    this.canonicalEntityName = canonicalEntityName;
    return this;
  }

  /**
   * Score indicating the saliency (centrality) of this entity to the original_text.
   * @return value or {@code null} for none
   */
  public java.lang.Double getEntitySalience() {
    return entitySalience;
  }

  /**
   * Score indicating the saliency (centrality) of this entity to the original_text.
   * @param entitySalience entitySalience or {@code null} for none
   */
  public VideoContentSearchSaftEntityInfo setEntitySalience(java.lang.Double entitySalience) {
    this.entitySalience = entitySalience;
    return this;
  }

  /**
   * The type name, like "/saft/person", "/saft/art". See README.entity-types for the inventory of
   * SAFT type tags.
   * @return value or {@code null} for none
   */
  public java.lang.String getEntityTypeName() {
    return entityTypeName;
  }

  /**
   * The type name, like "/saft/person", "/saft/art". See README.entity-types for the inventory of
   * SAFT type tags.
   * @param entityTypeName entityTypeName or {@code null} for none
   */
  public VideoContentSearchSaftEntityInfo setEntityTypeName(java.lang.String entityTypeName) {
    this.entityTypeName = entityTypeName;
    return this;
  }

  /**
   * Representative entity name mention extracted from original_text.
   * @return value or {@code null} for none
   */
  public java.lang.String getMentionText() {
    return mentionText;
  }

  /**
   * Representative entity name mention extracted from original_text.
   * @param mentionText mentionText or {@code null} for none
   */
  public VideoContentSearchSaftEntityInfo setMentionText(java.lang.String mentionText) {
    this.mentionText = mentionText;
    return this;
  }

  /**
   * SAFT Mention type.
   * @return value or {@code null} for none
   */
  public java.lang.String getMentionType() {
    return mentionType;
  }

  /**
   * SAFT Mention type.
   * @param mentionType mentionType or {@code null} for none
   */
  public VideoContentSearchSaftEntityInfo setMentionType(java.lang.String mentionType) {
    this.mentionType = mentionType;
    return this;
  }

  /**
   * Freebase MID for entity if this the saft entity corresponds to a Webref KG mid. This field is
   * not always populated and is taken from FREEBASE_MID mid in EntityProfile in the saft entity
   * annotation.
   * @return value or {@code null} for none
   */
  public java.lang.String getMid() {
    return mid;
  }

  /**
   * Freebase MID for entity if this the saft entity corresponds to a Webref KG mid. This field is
   * not always populated and is taken from FREEBASE_MID mid in EntityProfile in the saft entity
   * annotation.
   * @param mid mid or {@code null} for none
   */
  public VideoContentSearchSaftEntityInfo setMid(java.lang.String mid) {
    this.mid = mid;
    return this;
  }

  /**
   * The original input text (e.g. the anchor text) where the saft entity annotation was run on.
   * @return value or {@code null} for none
   */
  public java.lang.String getOriginalText() {
    return originalText;
  }

  /**
   * The original input text (e.g. the anchor text) where the saft entity annotation was run on.
   * @param originalText originalText or {@code null} for none
   */
  public VideoContentSearchSaftEntityInfo setOriginalText(java.lang.String originalText) {
    this.originalText = originalText;
    return this;
  }

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

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

}
