Interface PlanNodeOrBuilder (6.82.0)

Version 6.82.0

• 6.83.0 (latest)
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public interface PlanNodeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChildLinks(int index)

public abstract PlanNode.ChildLink getChildLinks(int index)

List of child node indexes and their relationship to this parent.

repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanNode.ChildLink

getChildLinksCount()

public abstract int getChildLinksCount()

List of child node indexes and their relationship to this parent.

repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

Returns
Type	Description
int

getChildLinksList()

public abstract List<PlanNode.ChildLink> getChildLinksList()

List of child node indexes and their relationship to this parent.

repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

Returns
Type	Description
List<ChildLink>

getChildLinksOrBuilder(int index)

public abstract PlanNode.ChildLinkOrBuilder getChildLinksOrBuilder(int index)

List of child node indexes and their relationship to this parent.

repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanNode.ChildLinkOrBuilder

getChildLinksOrBuilderList()

public abstract List<? extends PlanNode.ChildLinkOrBuilder> getChildLinksOrBuilderList()

List of child node indexes and their relationship to this parent.

repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

Returns
Type	Description
List<? extends com.google.spanner.v1.PlanNode.ChildLinkOrBuilder>

getDisplayName()

public abstract String getDisplayName()

The display name for the node.

string display_name = 3;

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The display name for the node.

string display_name = 3;

Returns
Type	Description
ByteString	The bytes for displayName.

getExecutionStats()

public abstract Struct 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.

.google.protobuf.Struct execution_stats = 7;

Returns
Type	Description
Struct	The executionStats.

getExecutionStatsOrBuilder()

public abstract StructOrBuilder getExecutionStatsOrBuilder()

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.

.google.protobuf.Struct execution_stats = 7;

Returns
Type	Description
StructOrBuilder

getIndex()

public abstract int getIndex()

The PlanNode's index in node list.

int32 index = 1;

Returns
Type	Description
int	The index.

getKind()

public abstract PlanNode.Kind 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.

.google.spanner.v1.PlanNode.Kind kind = 2;

Returns
Type	Description
PlanNode.Kind	The kind.

getKindValue()

public abstract int getKindValue()

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.

.google.spanner.v1.PlanNode.Kind kind = 2;

Returns
Type	Description
int	The enum numeric value on the wire for kind.

getMetadata()

public abstract Struct 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"
 }

.google.protobuf.Struct metadata = 6;

Returns
Type	Description
Struct	The metadata.

getMetadataOrBuilder()

public abstract StructOrBuilder getMetadataOrBuilder()

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"
 }

.google.protobuf.Struct metadata = 6;

Returns
Type	Description
StructOrBuilder

getShortRepresentation()

public abstract PlanNode.ShortRepresentation getShortRepresentation()

Condensed representation for SCALAR nodes.

.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

Returns
Type	Description
PlanNode.ShortRepresentation	The shortRepresentation.

getShortRepresentationOrBuilder()

public abstract PlanNode.ShortRepresentationOrBuilder getShortRepresentationOrBuilder()

Condensed representation for SCALAR nodes.

.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

Returns
Type	Description
PlanNode.ShortRepresentationOrBuilder

hasExecutionStats()

public abstract boolean hasExecutionStats()

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.

.google.protobuf.Struct execution_stats = 7;

Returns
Type	Description
boolean	Whether the executionStats field is set.

hasMetadata()

public abstract boolean hasMetadata()

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"
 }

.google.protobuf.Struct metadata = 6;

Returns
Type	Description
boolean	Whether the metadata field is set.

hasShortRepresentation()

public abstract boolean hasShortRepresentation()

Condensed representation for SCALAR nodes.

.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

Returns
Type	Description
boolean	Whether the shortRepresentation field is set.