com.google.api.services.docs.v1.model.Location Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-docs Show documentation
There is a newer version: v1-rev20240730-2.0.0
Show newest version
/*
 * 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.docs.v1.model;

/**
 * A particular location in the document.
 *
 *  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 Google Docs API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class Location extends com.google.api.client.json.GenericJson {

  /**
   * The zero-based index, in UTF-16 code units. The index is relative to the beginning of the
   * segment specified by segment_id.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer index;

  /**
   * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the
   * document's body.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String segmentId;

  /**
   * The zero-based index, in UTF-16 code units. The index is relative to the beginning of the
   * segment specified by segment_id.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getIndex() {
    return index;
  }

  /**
   * The zero-based index, in UTF-16 code units. The index is relative to the beginning of the
   * segment specified by segment_id.
   * @param index index or {@code null} for none
   */
  public Location setIndex(java.lang.Integer index) {
    this.index = index;
    return this;
  }

  /**
   * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the
   * document's body.
   * @return value or {@code null} for none
   */
  public java.lang.String getSegmentId() {
    return segmentId;
  }

  /**
   * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the
   * document's body.
   * @param segmentId segmentId or {@code null} for none
   */
  public Location setSegmentId(java.lang.String segmentId) {
    this.segmentId = segmentId;
    return this;
  }

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

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

}