com.google.api.services.datastore.model.CommitRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-datastore Show documentation
There is a newer version: v1-rev20241204-2.0.0
Show newest version
/*
 * Copyright 2010 Google Inc.
 *
 * 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://code.google.com/p/google-apis-client-generator/
 * (build: 2016-04-08 17:16:44 UTC)
 * on 2016-04-27 at 02:41:28 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.datastore.model;

/**
 * Model definition for CommitRequest.
 *
 *  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 Cloud Datastore API. For a detailed
 * explanation see:
 * http://code.google.com/p/google-http-java-client/wiki/JSON
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class CommitRequest extends com.google.api.client.json.GenericJson {

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

  /**
   * The mutation to perform. Optional.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Mutation mutation;

  /**
   * The transaction identifier, returned by a call to beginTransaction. Must be set when mode is
   * TRANSACTIONAL.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String transaction;

  /**
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getIgnoreReadOnly() {
    return ignoreReadOnly;
  }

  /**
   * @param ignoreReadOnly ignoreReadOnly or {@code null} for none
   */
  public CommitRequest setIgnoreReadOnly(java.lang.Boolean ignoreReadOnly) {
    this.ignoreReadOnly = ignoreReadOnly;
    return this;
  }

  /**
   * The mutation to perform. Optional.
   * @return value or {@code null} for none
   */
  public Mutation getMutation() {
    return mutation;
  }

  /**
   * The mutation to perform. Optional.
   * @param mutation mutation or {@code null} for none
   */
  public CommitRequest setMutation(Mutation mutation) {
    this.mutation = mutation;
    return this;
  }

  /**
   * The transaction identifier, returned by a call to beginTransaction. Must be set when mode is
   * TRANSACTIONAL.
   * @see #decodeTransaction()
   * @return value or {@code null} for none
   */
  public java.lang.String getTransaction() {
    return transaction;
  }

  /**
   * The transaction identifier, returned by a call to beginTransaction. Must be set when mode is
   * TRANSACTIONAL.
   * @see #getTransaction()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeTransaction() {
    return com.google.api.client.util.Base64.decodeBase64(transaction);
  }

  /**
   * The transaction identifier, returned by a call to beginTransaction. Must be set when mode is
   * TRANSACTIONAL.
   * @see #encodeTransaction()
   * @param transaction transaction or {@code null} for none
   */
  public CommitRequest setTransaction(java.lang.String transaction) {
    this.transaction = transaction;
    return this;
  }

  /**
   * The transaction identifier, returned by a call to beginTransaction. Must be set when mode is
   * TRANSACTIONAL.
   * @see #setTransaction()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public CommitRequest encodeTransaction(byte[] transaction) {
    this.transaction = com.google.api.client.util.Base64.encodeBase64URLSafeString(transaction);
    return this;
  }

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

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

}