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

Class PlanNode

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Node information for nodes appearing in a QueryPlan.plan_nodes.

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
PlanNode()

Method Summary

Modifier and Type	Method and Description
PlanNode	clone()
List<ChildLink>	getChildLinks() List of child node `index`es and their relationship to this parent.
String	getDisplayName() The display name for the node.
Map<String,Object>	getExecutionStats() The execution statistics associated with the node, contained in a group of key-value pairs.
Integer	getIndex() The `PlanNode`'s index in node list.
String	getKind() Used to determine the type of node.
Map<String,Object>	getMetadata() Attributes relevant to the node contained in a group of key-value pairs.
ShortRepresentation	getShortRepresentation() Condensed representation for SCALAR nodes.
PlanNode	set(String fieldName, Object value)
PlanNode	setChildLinks(List<ChildLink> childLinks) List of child node `index`es and their relationship to this parent.
PlanNode	setDisplayName(String displayName) The display name for the node.
PlanNode	setExecutionStats(Map<String,Object> executionStats) The execution statistics associated with the node, contained in a group of key-value pairs.
PlanNode	setIndex(Integer index) The `PlanNode`'s index in node list.
PlanNode	setKind(String kind) Used to determine the type of node.
PlanNode	setMetadata(Map<String,Object> metadata) Attributes relevant to the node contained in a group of key-value pairs.
PlanNode	setShortRepresentation(ShortRepresentation shortRepresentation) Condensed representation for SCALAR nodes.

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

PlanNode

public PlanNode()

Method Detail

getChildLinks

public List<ChildLink> getChildLinks()

List of child node `index`es and their relationship to this parent.

Returns:

value or null for none

setChildLinks

public PlanNode setChildLinks(List<ChildLink> childLinks)

List of child node `index`es and their relationship to this parent.

Parameters:

childLinks - childLinks or null for none

getDisplayName

public String getDisplayName()

The display name for the node.

Returns:

value or null for none

setDisplayName

public PlanNode setDisplayName(String displayName)

The display name for the node.

Parameters:

displayName - displayName or null for none

getExecutionStats

public Map<String,Object> getExecutionStats()

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

Returns:

value or null for none

setExecutionStats

public PlanNode setExecutionStats(Map<String,Object> executionStats)

The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.

Parameters:

executionStats - executionStats or null for none

getIndex

public Integer getIndex()

The `PlanNode`'s index in node list.

Returns:

value or null for none

setIndex

public PlanNode setIndex(Integer index)

The `PlanNode`'s index in node list.

Parameters:

index - index or null for none

getKind

public String getKind()

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

Returns:

value or null for none

setKind

public PlanNode setKind(String kind)

Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.

Parameters:

kind - kind or null for none

getMetadata

public Map<String,Object> getMetadata()

Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }

Returns:

value or null for none

setMetadata

public PlanNode setMetadata(Map<String,Object> metadata)

Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" }

Parameters:

metadata - metadata or null for none

getShortRepresentation

public ShortRepresentation getShortRepresentation()

Condensed representation for SCALAR nodes.

Returns:

value or null for none

setShortRepresentation

public PlanNode setShortRepresentation(ShortRepresentation shortRepresentation)

Condensed representation for SCALAR nodes.

Parameters:

shortRepresentation - shortRepresentation or null for none

set

public PlanNode set(String fieldName,
                    Object value)

Overrides:

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

clone

public PlanNode clone()

Overrides:

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