Class PlanNode 

public final class PlanNode extends GeneratedMessageV3 implements PlanNodeOrBuilder

Node information for nodes appearing in a QueryPlan.plan_nodes.

Protobuf type google.spanner.v1.PlanNode

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PlanNode

Implements

PlanNodeOrBuilder

Static Fields 

public static final int CHILD_LINKS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_STATS_FIELD_NUMBER

public static final int EXECUTION_STATS_FIELD_NUMBER
Field Value
Type Description
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

SHORT_REPRESENTATION_FIELD_NUMBER

public static final int SHORT_REPRESENTATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PlanNode getDefaultInstance()
Returns
Type Description
PlanNode

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PlanNode.Builder newBuilder()
Returns
Type Description
PlanNode.Builder

newBuilder(PlanNode prototype)

public static PlanNode.Builder newBuilder(PlanNode prototype)
Parameter
Name Description
prototype PlanNode
Returns
Type Description
PlanNode.Builder

parseDelimitedFrom(InputStream input)

public static PlanNode parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PlanNode
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlanNode parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanNode
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PlanNode parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PlanNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PlanNode parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PlanNode parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PlanNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PlanNode parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PlanNode parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PlanNode
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PlanNode parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanNode
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PlanNode parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PlanNode
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PlanNode parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanNode
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PlanNode parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PlanNode
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PlanNode parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PlanNode
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PlanNode> parser()
Returns
Type Description
Parser<PlanNode>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getChildLinks(int index)

public 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 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 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 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 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>

getDefaultInstanceForType()

public PlanNode getDefaultInstanceForType()
Returns
Type Description
PlanNode

getDisplayName()

public String getDisplayName()

The display name for the node.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name for the node.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getExecutionStats()

public 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 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 int getIndex()

The PlanNode's index in node list.

int32 index = 1;

Returns
Type Description
int

The index.

getKind()

public 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 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 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 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

getParserForType()

public Parser<PlanNode> getParserForType()
Returns
Type Description
Parser<PlanNode>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShortRepresentation()

public 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 PlanNode.ShortRepresentationOrBuilder getShortRepresentationOrBuilder()

Condensed representation for SCALAR nodes.

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

Returns
Type Description
PlanNode.ShortRepresentationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasExecutionStats()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PlanNode.Builder newBuilderForType()
Returns
Type Description
PlanNode.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PlanNode.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PlanNode.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PlanNode.Builder toBuilder()
Returns
Type Description
PlanNode.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException