com.google.api.services.spanner.v1.model.DirectedReadOptions 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 DirectedReadOptions can be used to indicate which replicas or regions should be used for non-
 * transactional reads or queries. DirectedReadOptions may only be specified for a read-only
 * transaction, otherwise the API will return an `INVALID_ARGUMENT` error.
 *
 *  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 DirectedReadOptions extends com.google.api.client.json.GenericJson {

  /**
   * Exclude_replicas indicates that specified replicas should be excluded from serving requests.
   * Spanner will not route requests to the replicas in this list.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private ExcludeReplicas excludeReplicas;

  /**
   * Include_replicas indicates the order of replicas (as they appear in this list) to process the
   * request. If auto_failover_disabled is set to true and all replicas are exhausted without
   * finding a healthy replica, Spanner will wait for a replica in the list to become available,
   * requests may fail due to `DEADLINE_EXCEEDED` errors.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private IncludeReplicas includeReplicas;

  /**
   * Exclude_replicas indicates that specified replicas should be excluded from serving requests.
   * Spanner will not route requests to the replicas in this list.
   * @return value or {@code null} for none
   */
  public ExcludeReplicas getExcludeReplicas() {
    return excludeReplicas;
  }

  /**
   * Exclude_replicas indicates that specified replicas should be excluded from serving requests.
   * Spanner will not route requests to the replicas in this list.
   * @param excludeReplicas excludeReplicas or {@code null} for none
   */
  public DirectedReadOptions setExcludeReplicas(ExcludeReplicas excludeReplicas) {
    this.excludeReplicas = excludeReplicas;
    return this;
  }

  /**
   * Include_replicas indicates the order of replicas (as they appear in this list) to process the
   * request. If auto_failover_disabled is set to true and all replicas are exhausted without
   * finding a healthy replica, Spanner will wait for a replica in the list to become available,
   * requests may fail due to `DEADLINE_EXCEEDED` errors.
   * @return value or {@code null} for none
   */
  public IncludeReplicas getIncludeReplicas() {
    return includeReplicas;
  }

  /**
   * Include_replicas indicates the order of replicas (as they appear in this list) to process the
   * request. If auto_failover_disabled is set to true and all replicas are exhausted without
   * finding a healthy replica, Spanner will wait for a replica in the list to become available,
   * requests may fail due to `DEADLINE_EXCEEDED` errors.
   * @param includeReplicas includeReplicas or {@code null} for none
   */
  public DirectedReadOptions setIncludeReplicas(IncludeReplicas includeReplicas) {
    this.includeReplicas = includeReplicas;
    return this;
  }

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

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

}