com.google.api.services.spanner.v1.model.BatchWriteResponse Maven / Gradle / Ivy

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

/**
 * The result of applying a batch of mutations.
 *
 *  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 Cloud Spanner 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 BatchWriteResponse extends com.google.api.client.json.GenericJson {

  /**
   * The commit timestamp of the transaction that applied this batch. Present if `status` is `OK`,
   * absent otherwise.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String commitTimestamp;

  /**
   * The mutation groups applied in this batch. The values index into the `mutation_groups` field in
   * the corresponding `BatchWriteRequest`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List indexes;

  /**
   * An `OK` status indicates success. Any other status indicates a failure.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private Status status;

  /**
   * The commit timestamp of the transaction that applied this batch. Present if `status` is `OK`,
   * absent otherwise.
   * @return value or {@code null} for none
   */
  public String getCommitTimestamp() {
    return commitTimestamp;
  }

  /**
   * The commit timestamp of the transaction that applied this batch. Present if `status` is `OK`,
   * absent otherwise.
   * @param commitTimestamp commitTimestamp or {@code null} for none
   */
  public BatchWriteResponse setCommitTimestamp(String commitTimestamp) {
    this.commitTimestamp = commitTimestamp;
    return this;
  }

  /**
   * The mutation groups applied in this batch. The values index into the `mutation_groups` field in
   * the corresponding `BatchWriteRequest`.
   * @return value or {@code null} for none
   */
  public java.util.List getIndexes() {
    return indexes;
  }

  /**
   * The mutation groups applied in this batch. The values index into the `mutation_groups` field in
   * the corresponding `BatchWriteRequest`.
   * @param indexes indexes or {@code null} for none
   */
  public BatchWriteResponse setIndexes(java.util.List indexes) {
    this.indexes = indexes;
    return this;
  }

  /**
   * An `OK` status indicates success. Any other status indicates a failure.
   * @return value or {@code null} for none
   */
  public Status getStatus() {
    return status;
  }

  /**
   * An `OK` status indicates success. Any other status indicates a failure.
   * @param status status or {@code null} for none
   */
  public BatchWriteResponse setStatus(Status status) {
    this.status = status;
    return this;
  }

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

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

}