com.google.api.services.spanner.v1.model.BeginTransactionRequest 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-rev20241119-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 request for BeginTransaction.
 *
 *  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 BeginTransactionRequest extends com.google.api.client.json.GenericJson {

  /**
   * Required. Options for the new transaction.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TransactionOptions options;

  /**
   * Common options for this request. Priority is ignored for this request. Setting the priority in
   * this request_options struct will not do anything. To set the priority for a transaction, set it
   * on the reads and writes that are part of this transaction instead.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private RequestOptions requestOptions;

  /**
   * Required. Options for the new transaction.
   * @return value or {@code null} for none
   */
  public TransactionOptions getOptions() {
    return options;
  }

  /**
   * Required. Options for the new transaction.
   * @param options options or {@code null} for none
   */
  public BeginTransactionRequest setOptions(TransactionOptions options) {
    this.options = options;
    return this;
  }

  /**
   * Common options for this request. Priority is ignored for this request. Setting the priority in
   * this request_options struct will not do anything. To set the priority for a transaction, set it
   * on the reads and writes that are part of this transaction instead.
   * @return value or {@code null} for none
   */
  public RequestOptions getRequestOptions() {
    return requestOptions;
  }

  /**
   * Common options for this request. Priority is ignored for this request. Setting the priority in
   * this request_options struct will not do anything. To set the priority for a transaction, set it
   * on the reads and writes that are part of this transaction instead.
   * @param requestOptions requestOptions or {@code null} for none
   */
  public BeginTransactionRequest setRequestOptions(RequestOptions requestOptions) {
    this.requestOptions = requestOptions;
    return this;
  }

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

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

}