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

/**
 * Query optimizer configuration.
 *
 *  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 QueryOptions extends com.google.api.client.json.GenericJson {

  /**
   * An option to control the selection of optimizer statistics package. This parameter allows
   * individual queries to use a different query optimizer statistics package. Specifying `latest`
   * as a value instructs Cloud Spanner to use the latest generated statistics package. If not
   * specified, Cloud Spanner uses the statistics package set at the database level options, or the
   * latest package if the database option is not set. The statistics package requested by the query
   * has to be exempt from garbage collection. This can be achieved with the following DDL
   * statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available
   * statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a
   * SQL statement with an invalid optimizer statistics package or with a statistics package that
   * allows garbage collection fails with an `INVALID_ARGUMENT` error.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String optimizerStatisticsPackage;

  /**
   * An option to control the selection of optimizer version. This parameter allows individual
   * queries to pick different query optimizer versions. Specifying `latest` as a value instructs
   * Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud
   * Spanner uses the optimizer version set at the database level options. Any other positive
   * integer (from the list of supported optimizer versions) overrides the default optimizer version
   * for query execution. The list of supported optimizer versions can be queried from
   * SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an invalid optimizer
   * version fails with an `INVALID_ARGUMENT` error. See
   * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more
   * information on managing the query optimizer. The `optimizer_version` statement hint has
   * precedence over this setting.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String optimizerVersion;

  /**
   * An option to control the selection of optimizer statistics package. This parameter allows
   * individual queries to use a different query optimizer statistics package. Specifying `latest`
   * as a value instructs Cloud Spanner to use the latest generated statistics package. If not
   * specified, Cloud Spanner uses the statistics package set at the database level options, or the
   * latest package if the database option is not set. The statistics package requested by the query
   * has to be exempt from garbage collection. This can be achieved with the following DDL
   * statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available
   * statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a
   * SQL statement with an invalid optimizer statistics package or with a statistics package that
   * allows garbage collection fails with an `INVALID_ARGUMENT` error.
   * @return value or {@code null} for none
   */
  public java.lang.String getOptimizerStatisticsPackage() {
    return optimizerStatisticsPackage;
  }

  /**
   * An option to control the selection of optimizer statistics package. This parameter allows
   * individual queries to use a different query optimizer statistics package. Specifying `latest`
   * as a value instructs Cloud Spanner to use the latest generated statistics package. If not
   * specified, Cloud Spanner uses the statistics package set at the database level options, or the
   * latest package if the database option is not set. The statistics package requested by the query
   * has to be exempt from garbage collection. This can be achieved with the following DDL
   * statement: ``` ALTER STATISTICS SET OPTIONS (allow_gc=false) ``` The list of available
   * statistics packages can be queried from `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a
   * SQL statement with an invalid optimizer statistics package or with a statistics package that
   * allows garbage collection fails with an `INVALID_ARGUMENT` error.
   * @param optimizerStatisticsPackage optimizerStatisticsPackage or {@code null} for none
   */
  public QueryOptions setOptimizerStatisticsPackage(java.lang.String optimizerStatisticsPackage) {
    this.optimizerStatisticsPackage = optimizerStatisticsPackage;
    return this;
  }

  /**
   * An option to control the selection of optimizer version. This parameter allows individual
   * queries to pick different query optimizer versions. Specifying `latest` as a value instructs
   * Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud
   * Spanner uses the optimizer version set at the database level options. Any other positive
   * integer (from the list of supported optimizer versions) overrides the default optimizer version
   * for query execution. The list of supported optimizer versions can be queried from
   * SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an invalid optimizer
   * version fails with an `INVALID_ARGUMENT` error. See
   * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more
   * information on managing the query optimizer. The `optimizer_version` statement hint has
   * precedence over this setting.
   * @return value or {@code null} for none
   */
  public java.lang.String getOptimizerVersion() {
    return optimizerVersion;
  }

  /**
   * An option to control the selection of optimizer version. This parameter allows individual
   * queries to pick different query optimizer versions. Specifying `latest` as a value instructs
   * Cloud Spanner to use the latest supported query optimizer version. If not specified, Cloud
   * Spanner uses the optimizer version set at the database level options. Any other positive
   * integer (from the list of supported optimizer versions) overrides the default optimizer version
   * for query execution. The list of supported optimizer versions can be queried from
   * SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement with an invalid optimizer
   * version fails with an `INVALID_ARGUMENT` error. See
   * https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer for more
   * information on managing the query optimizer. The `optimizer_version` statement hint has
   * precedence over this setting.
   * @param optimizerVersion optimizerVersion or {@code null} for none
   */
  public QueryOptions setOptimizerVersion(java.lang.String optimizerVersion) {
    this.optimizerVersion = optimizerVersion;
    return this;
  }

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

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

}