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

/**
 * Common request options for various APIs.
 *
 *  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 RequestOptions extends com.google.api.client.json.GenericJson {

  /**
   * Priority for the request.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String priority;

  /**
   * A per-request tag which can be applied to queries or reads, used for statistics collection.
   * Both request_tag and transaction_tag can be specified for a read or query that belongs to a
   * transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest).
   * Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the
   * length of a request_tag is limited to 50 characters. Values that exceed this limit are
   * truncated. Any leading underscore (_) characters will be removed from the string.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String requestTag;

  /**
   * A tag used for statistics collection about this transaction. Both request_tag and
   * transaction_tag can be specified for a read or query that belongs to a transaction. The value
   * of transaction_tag should be the same for all requests belonging to the same transaction. If
   * this request doesn't belong to any transaction, transaction_tag will be ignored. Legal
   * characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the
   * length of a transaction_tag is limited to 50 characters. Values that exceed this limit are
   * truncated. Any leading underscore (_) characters will be removed from the string.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String transactionTag;

  /**
   * Priority for the request.
   * @return value or {@code null} for none
   */
  public java.lang.String getPriority() {
    return priority;
  }

  /**
   * Priority for the request.
   * @param priority priority or {@code null} for none
   */
  public RequestOptions setPriority(java.lang.String priority) {
    this.priority = priority;
    return this;
  }

  /**
   * A per-request tag which can be applied to queries or reads, used for statistics collection.
   * Both request_tag and transaction_tag can be specified for a read or query that belongs to a
   * transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest).
   * Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the
   * length of a request_tag is limited to 50 characters. Values that exceed this limit are
   * truncated. Any leading underscore (_) characters will be removed from the string.
   * @return value or {@code null} for none
   */
  public java.lang.String getRequestTag() {
    return requestTag;
  }

  /**
   * A per-request tag which can be applied to queries or reads, used for statistics collection.
   * Both request_tag and transaction_tag can be specified for a read or query that belongs to a
   * transaction. This field is ignored for requests where it's not applicable (e.g. CommitRequest).
   * Legal characters for `request_tag` values are all printable characters (ASCII 32 - 126) and the
   * length of a request_tag is limited to 50 characters. Values that exceed this limit are
   * truncated. Any leading underscore (_) characters will be removed from the string.
   * @param requestTag requestTag or {@code null} for none
   */
  public RequestOptions setRequestTag(java.lang.String requestTag) {
    this.requestTag = requestTag;
    return this;
  }

  /**
   * A tag used for statistics collection about this transaction. Both request_tag and
   * transaction_tag can be specified for a read or query that belongs to a transaction. The value
   * of transaction_tag should be the same for all requests belonging to the same transaction. If
   * this request doesn't belong to any transaction, transaction_tag will be ignored. Legal
   * characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the
   * length of a transaction_tag is limited to 50 characters. Values that exceed this limit are
   * truncated. Any leading underscore (_) characters will be removed from the string.
   * @return value or {@code null} for none
   */
  public java.lang.String getTransactionTag() {
    return transactionTag;
  }

  /**
   * A tag used for statistics collection about this transaction. Both request_tag and
   * transaction_tag can be specified for a read or query that belongs to a transaction. The value
   * of transaction_tag should be the same for all requests belonging to the same transaction. If
   * this request doesn't belong to any transaction, transaction_tag will be ignored. Legal
   * characters for `transaction_tag` values are all printable characters (ASCII 32 - 126) and the
   * length of a transaction_tag is limited to 50 characters. Values that exceed this limit are
   * truncated. Any leading underscore (_) characters will be removed from the string.
   * @param transactionTag transactionTag or {@code null} for none
   */
  public RequestOptions setTransactionTag(java.lang.String transactionTag) {
    this.transactionTag = transactionTag;
    return this;
  }

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

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

}