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

/**
 * Provides control over how write requests are executed.
 *
 *  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 WriteControl extends com.google.api.client.json.GenericJson {

  /**
   * The optional revision ID of the document the write request is applied to. If this is not the
   * latest revision of the document, the request is not processed and returns a 400 bad request
   * error. When a required revision ID is returned in a response, it indicates the revision ID of
   * the document after the request was applied.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String requiredRevisionId;

  /**
   * The optional target revision ID of the document the write request is applied to. If
   * collaborator changes have occurred after the document was read using the API, the changes
   * produced by this write request are applied against the collaborator changes. This results in a
   * new revision of the document that incorporates both the collaborator changes and the changes in
   * the request, with the Docs server resolving conflicting changes. When using target revision ID,
   * the API client can be thought of as another collaborator of the document. The target revision
   * ID can only be used to write to recent versions of a document. If the target revision is too
   * far behind the latest revision, the request is not processed and returns a 400 bad request
   * error. The request should be tried again after retrieving the latest version of the document.
   * Usually a revision ID remains valid for use as a target revision for several minutes after it's
   * read, but for frequently edited documents this window might be shorter.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String targetRevisionId;

  /**
   * The optional revision ID of the document the write request is applied to. If this is not the
   * latest revision of the document, the request is not processed and returns a 400 bad request
   * error. When a required revision ID is returned in a response, it indicates the revision ID of
   * the document after the request was applied.
   * @return value or {@code null} for none
   */
  public java.lang.String getRequiredRevisionId() {
    return requiredRevisionId;
  }

  /**
   * The optional revision ID of the document the write request is applied to. If this is not the
   * latest revision of the document, the request is not processed and returns a 400 bad request
   * error. When a required revision ID is returned in a response, it indicates the revision ID of
   * the document after the request was applied.
   * @param requiredRevisionId requiredRevisionId or {@code null} for none
   */
  public WriteControl setRequiredRevisionId(java.lang.String requiredRevisionId) {
    this.requiredRevisionId = requiredRevisionId;
    return this;
  }

  /**
   * The optional target revision ID of the document the write request is applied to. If
   * collaborator changes have occurred after the document was read using the API, the changes
   * produced by this write request are applied against the collaborator changes. This results in a
   * new revision of the document that incorporates both the collaborator changes and the changes in
   * the request, with the Docs server resolving conflicting changes. When using target revision ID,
   * the API client can be thought of as another collaborator of the document. The target revision
   * ID can only be used to write to recent versions of a document. If the target revision is too
   * far behind the latest revision, the request is not processed and returns a 400 bad request
   * error. The request should be tried again after retrieving the latest version of the document.
   * Usually a revision ID remains valid for use as a target revision for several minutes after it's
   * read, but for frequently edited documents this window might be shorter.
   * @return value or {@code null} for none
   */
  public java.lang.String getTargetRevisionId() {
    return targetRevisionId;
  }

  /**
   * The optional target revision ID of the document the write request is applied to. If
   * collaborator changes have occurred after the document was read using the API, the changes
   * produced by this write request are applied against the collaborator changes. This results in a
   * new revision of the document that incorporates both the collaborator changes and the changes in
   * the request, with the Docs server resolving conflicting changes. When using target revision ID,
   * the API client can be thought of as another collaborator of the document. The target revision
   * ID can only be used to write to recent versions of a document. If the target revision is too
   * far behind the latest revision, the request is not processed and returns a 400 bad request
   * error. The request should be tried again after retrieving the latest version of the document.
   * Usually a revision ID remains valid for use as a target revision for several minutes after it's
   * read, but for frequently edited documents this window might be shorter.
   * @param targetRevisionId targetRevisionId or {@code null} for none
   */
  public WriteControl setTargetRevisionId(java.lang.String targetRevisionId) {
    this.targetRevisionId = targetRevisionId;
    return this;
  }

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

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

}