com.google.api.services.docs.v1.model.CreateFooterRequest 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;

/**
 * Creates a Footer. The new footer is applied to the SectionStyle at the location of the
 * SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a footer of the
 * specified type already exists, a 400 bad request error is returned.
 *
 *  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 CreateFooterRequest extends com.google.api.client.json.GenericJson {

  /**
   * The location of the SectionBreak immediately preceding the section whose SectionStyle this
   * footer should belong to. If this is unset or refers to the first section break in the document,
   * the footer applies to the document style.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Location sectionBreakLocation;

  /**
   * The type of footer to create.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String type;

  /**
   * The location of the SectionBreak immediately preceding the section whose SectionStyle this
   * footer should belong to. If this is unset or refers to the first section break in the document,
   * the footer applies to the document style.
   * @return value or {@code null} for none
   */
  public Location getSectionBreakLocation() {
    return sectionBreakLocation;
  }

  /**
   * The location of the SectionBreak immediately preceding the section whose SectionStyle this
   * footer should belong to. If this is unset or refers to the first section break in the document,
   * the footer applies to the document style.
   * @param sectionBreakLocation sectionBreakLocation or {@code null} for none
   */
  public CreateFooterRequest setSectionBreakLocation(Location sectionBreakLocation) {
    this.sectionBreakLocation = sectionBreakLocation;
    return this;
  }

  /**
   * The type of footer to create.
   * @return value or {@code null} for none
   */
  public java.lang.String getType() {
    return type;
  }

  /**
   * The type of footer to create.
   * @param type type or {@code null} for none
   */
  public CreateFooterRequest setType(java.lang.String type) {
    this.type = type;
    return this;
  }

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

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

}