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

/**
 * A single understood lexicon of the |category| on byte range from |begin_offset| (inclusive) to
 * |end_offset| (exclusive). The offsets are all byte offsets relative to the full original query
 * and cover both the mentions and surrounding markers.
 *
 * <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 RepositoryWebrefLexicalRange extends com.google.api.client.json.GenericJson {

  /**
   * Begin byte offset relative to the full original query.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer beginOffset;

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

  /**
   * Direction defines the relation between the measurable aspect and the facet.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String direction;

  /**
   * End byte offset relative to the full original query.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer endOffset;

  /**
   * The mid of the facet associated with ASPECT category.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.math.BigInteger facetMid;

  /**
   * Begin byte offset relative to the full original query.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getBeginOffset() {
    return beginOffset;
  }

  /**
   * Begin byte offset relative to the full original query.
   * @param beginOffset beginOffset or {@code null} for none
   */
  public RepositoryWebrefLexicalRange setBeginOffset(java.lang.Integer beginOffset) {
    this.beginOffset = beginOffset;
    return this;
  }

  /**
   * @return value or {@code null} for none
   */
  public java.lang.String getCategory() {
    return category;
  }

  /**
   * @param category category or {@code null} for none
   */
  public RepositoryWebrefLexicalRange setCategory(java.lang.String category) {
    this.category = category;
    return this;
  }

  /**
   * Direction defines the relation between the measurable aspect and the facet.
   * @return value or {@code null} for none
   */
  public java.lang.String getDirection() {
    return direction;
  }

  /**
   * Direction defines the relation between the measurable aspect and the facet.
   * @param direction direction or {@code null} for none
   */
  public RepositoryWebrefLexicalRange setDirection(java.lang.String direction) {
    this.direction = direction;
    return this;
  }

  /**
   * End byte offset relative to the full original query.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getEndOffset() {
    return endOffset;
  }

  /**
   * End byte offset relative to the full original query.
   * @param endOffset endOffset or {@code null} for none
   */
  public RepositoryWebrefLexicalRange setEndOffset(java.lang.Integer endOffset) {
    this.endOffset = endOffset;
    return this;
  }

  /**
   * The mid of the facet associated with ASPECT category.
   * @return value or {@code null} for none
   */
  public java.math.BigInteger getFacetMid() {
    return facetMid;
  }

  /**
   * The mid of the facet associated with ASPECT category.
   * @param facetMid facetMid or {@code null} for none
   */
  public RepositoryWebrefLexicalRange setFacetMid(java.math.BigInteger facetMid) {
    this.facetMid = facetMid;
    return this;
  }

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

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

}
