com.google.api.services.spanner.v1.model

Class QueryPlan

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.QueryPlan

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class QueryPlan
extends com.google.api.client.json.GenericJson

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
QueryPlan()

Method Summary

Modifier and Type	Method and Description
QueryPlan	clone()
List<PlanNode>	getPlanNodes() The nodes in the query plan.
QueryAdvisorResult	getQueryAdvice() Optional.
QueryPlan	set(String fieldName, Object value)
QueryPlan	setPlanNodes(List<PlanNode> planNodes) The nodes in the query plan.
QueryPlan	setQueryAdvice(QueryAdvisorResult queryAdvice) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

QueryPlan

public QueryPlan()

Method Detail

getPlanNodes

public List<PlanNode> getPlanNodes()

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`.

Returns:

value or null for none

setPlanNodes

public QueryPlan setPlanNodes(List<PlanNode> 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`.

Parameters:

planNodes - planNodes or null for none

getQueryAdvice

public QueryAdvisorResult getQueryAdvice()

Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query.

Returns:

value or null for none

setQueryAdvice

public QueryPlan setQueryAdvice(QueryAdvisorResult queryAdvice)

Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query.

Parameters:

queryAdvice - queryAdvice or null for none

set

public QueryPlan set(String fieldName,
                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public QueryPlan clone()

Overrides:

clone in class com.google.api.client.json.GenericJson