<?php
/*
 * Copyright 2014 Google Inc.
 *
 * 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.
 */

namespace Google\Service\Spanner;

class QueryOptions extends \Google\Model
{
  /**
   * 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 isn't set. The statistics package
   * requested by the query has to be exempt from garbage collection. This can
   * be achieved with the following DDL statement: ```sql 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.
   *
   * @var string
   */
  public $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.
   *
   * @var string
   */
  public $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 isn't set. The statistics package
   * requested by the query has to be exempt from garbage collection. This can
   * be achieved with the following DDL statement: ```sql 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 string $optimizerStatisticsPackage
   */
  public function setOptimizerStatisticsPackage($optimizerStatisticsPackage)
  {
    $this->optimizerStatisticsPackage = $optimizerStatisticsPackage;
  }
  /**
   * @return string
   */
  public function getOptimizerStatisticsPackage()
  {
    return $this->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.
   *
   * @param string $optimizerVersion
   */
  public function setOptimizerVersion($optimizerVersion)
  {
    $this->optimizerVersion = $optimizerVersion;
  }
  /**
   * @return string
   */
  public function getOptimizerVersion()
  {
    return $this->optimizerVersion;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(QueryOptions::class, 'Google_Service_Spanner_QueryOptions');