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

/**
 * Reference to a component of a compound mention. Next available tag: 5
 *
 * <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 RepositoryWebrefMentionComponent extends com.google.api.client.json.GenericJson {

  /**
   * The indices to identify the entity within the WebrefEntities.entities, the segment within its
   * EntityAnnotations.segment_mentions, and the mention within that segment. entity_index is always
   * guaranteed to be set, but segment_mentions_index and mention_index are omitted if the component
   * reference is implicit.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer entityIndex;

  /**
   * The source of the compound has designated this component as the head. Only one of the
   * components can be a head, but it's possible none are.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean isHeadComponent;

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

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

  /**
   * The indices to identify the entity within the WebrefEntities.entities, the segment within its
   * EntityAnnotations.segment_mentions, and the mention within that segment. entity_index is always
   * guaranteed to be set, but segment_mentions_index and mention_index are omitted if the component
   * reference is implicit.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getEntityIndex() {
    return entityIndex;
  }

  /**
   * The indices to identify the entity within the WebrefEntities.entities, the segment within its
   * EntityAnnotations.segment_mentions, and the mention within that segment. entity_index is always
   * guaranteed to be set, but segment_mentions_index and mention_index are omitted if the component
   * reference is implicit.
   * @param entityIndex entityIndex or {@code null} for none
   */
  public RepositoryWebrefMentionComponent setEntityIndex(java.lang.Integer entityIndex) {
    this.entityIndex = entityIndex;
    return this;
  }

  /**
   * The source of the compound has designated this component as the head. Only one of the
   * components can be a head, but it's possible none are.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIsHeadComponent() {
    return isHeadComponent;
  }

  /**
   * The source of the compound has designated this component as the head. Only one of the
   * components can be a head, but it's possible none are.
   * @param isHeadComponent isHeadComponent or {@code null} for none
   */
  public RepositoryWebrefMentionComponent setIsHeadComponent(java.lang.Boolean isHeadComponent) {
    this.isHeadComponent = isHeadComponent;
    return this;
  }

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

  /**
   * @param mentionIndex mentionIndex or {@code null} for none
   */
  public RepositoryWebrefMentionComponent setMentionIndex(java.lang.Integer mentionIndex) {
    this.mentionIndex = mentionIndex;
    return this;
  }

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

  /**
   * @param segmentMentionsIndex segmentMentionsIndex or {@code null} for none
   */
  public RepositoryWebrefMentionComponent setSegmentMentionsIndex(java.lang.Integer segmentMentionsIndex) {
    this.segmentMentionsIndex = segmentMentionsIndex;
    return this;
  }

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

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

}
