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

/**
 * Contains an ordered list of nodes appearing in the query plan.
 *
 *  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 QueryPlan extends com.google.api.client.json.GenericJson {

  /**
   * The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root.
   * Each PlanNode's `id` corresponds to its index in `plan_nodes`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List planNodes;

  static {
    // hack to force ProGuard to consider PlanNode used, since otherwise it would be stripped out
    // see https://github.com/google/google-api-java-client/issues/543
    com.google.api.client.util.Data.nullOf(PlanNode.class);
  }

  /**
   * Optional. The advices/recommendations for a query. Currently this field will be serving index
   * recommendations for a query.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private QueryAdvisorResult queryAdvice;

  /**
   * The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root.
   * Each PlanNode's `id` corresponds to its index in `plan_nodes`.
   * @return value or {@code null} for none
   */
  public java.util.List getPlanNodes() {
    return planNodes;
  }

  /**
   * The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root.
   * Each PlanNode's `id` corresponds to its index in `plan_nodes`.
   * @param planNodes planNodes or {@code null} for none
   */
  public QueryPlan setPlanNodes(java.util.List planNodes) {
    this.planNodes = planNodes;
    return this;
  }

  /**
   * Optional. The advices/recommendations for a query. Currently this field will be serving index
   * recommendations for a query.
   * @return value or {@code null} for none
   */
  public QueryAdvisorResult getQueryAdvice() {
    return queryAdvice;
  }

  /**
   * Optional. The advices/recommendations for a query. Currently this field will be serving index
   * recommendations for a query.
   * @param queryAdvice queryAdvice or {@code null} for none
   */
  public QueryPlan setQueryAdvice(QueryAdvisorResult queryAdvice) {
    this.queryAdvice = queryAdvice;
    return this;
  }

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

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

}