com.google.spanner.v1

Class PlanNode

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.spanner.v1.PlanNode

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, PlanNodeOrBuilder, Serializable

public final class PlanNode
extends GeneratedMessageV3
implements PlanNodeOrBuilder

 Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
 

Protobuf type google.spanner.v1.PlanNode

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlanNode.Builder Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
static class	PlanNode.ChildLink Metadata associated with a parent-child relationship appearing in a [PlanNode][google.spanner.v1.PlanNode].
static interface	PlanNode.ChildLinkOrBuilder
static class	PlanNode.Kind The kind of [PlanNode][google.spanner.v1.PlanNode].
static class	PlanNode.ShortRepresentation Condensed representation of a node and its subtree.
static interface	PlanNode.ShortRepresentationOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHILD_LINKS_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	EXECUTION_STATS_FIELD_NUMBER
static int	INDEX_FIELD_NUMBER
static int	KIND_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	SHORT_REPRESENTATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
PlanNode.ChildLink	getChildLinks(int index) List of child node `index`es and their relationship to this parent.
int	getChildLinksCount() List of child node `index`es and their relationship to this parent.
List<PlanNode.ChildLink>	getChildLinksList() List of child node `index`es and their relationship to this parent.
PlanNode.ChildLinkOrBuilder	getChildLinksOrBuilder(int index) List of child node `index`es and their relationship to this parent.
List<? extends PlanNode.ChildLinkOrBuilder>	getChildLinksOrBuilderList() List of child node `index`es and their relationship to this parent.
static PlanNode	getDefaultInstance()
PlanNode	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getDisplayName() The display name for the node.
ByteString	getDisplayNameBytes() The display name for the node.
Struct	getExecutionStats() The execution statistics associated with the node, contained in a group of key-value pairs.
StructOrBuilder	getExecutionStatsOrBuilder() The execution statistics associated with the node, contained in a group of key-value pairs.
int	getIndex() The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
PlanNode.Kind	getKind() Used to determine the type of node.
int	getKindValue() Used to determine the type of node.
Struct	getMetadata() Attributes relevant to the node contained in a group of key-value pairs.
StructOrBuilder	getMetadataOrBuilder() Attributes relevant to the node contained in a group of key-value pairs.
Parser<PlanNode>	getParserForType()
int	getSerializedSize()
PlanNode.ShortRepresentation	getShortRepresentation() Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
PlanNode.ShortRepresentationOrBuilder	getShortRepresentationOrBuilder() Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
UnknownFieldSet	getUnknownFields()
boolean	hasExecutionStats() The execution statistics associated with the node, contained in a group of key-value pairs.
int	hashCode()
boolean	hasMetadata() Attributes relevant to the node contained in a group of key-value pairs.
boolean	hasShortRepresentation() Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PlanNode.Builder	newBuilder()
static PlanNode.Builder	newBuilder(PlanNode prototype)
PlanNode.Builder	newBuilderForType()
protected PlanNode.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static PlanNode	parseDelimitedFrom(InputStream input)
static PlanNode	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static PlanNode	parseFrom(byte[] data)
static PlanNode	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static PlanNode	parseFrom(ByteBuffer data)
static PlanNode	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static PlanNode	parseFrom(ByteString data)
static PlanNode	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static PlanNode	parseFrom(CodedInputStream input)
static PlanNode	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static PlanNode	parseFrom(InputStream input)
static PlanNode	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<PlanNode>	parser()
PlanNode.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER

See Also:

Constant Field Values

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CHILD_LINKS_FIELD_NUMBER

public static final int CHILD_LINKS_FIELD_NUMBER

See Also:

Constant Field Values

SHORT_REPRESENTATION_FIELD_NUMBER

public static final int SHORT_REPRESENTATION_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

EXECUTION_STATS_FIELD_NUMBER

public static final int EXECUTION_STATS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getIndex

public int getIndex()

 The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
 

int32 index = 1;

Specified by:

getIndex in interface PlanNodeOrBuilder

Returns:

The index.

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][google.spanner.v1.PlanNode.Kind.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;

Specified by:

getKindValue in interface PlanNodeOrBuilder

Returns:

The enum numeric value on the wire for kind.

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][google.spanner.v1.PlanNode.Kind.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;

Specified by:

getKind in interface PlanNodeOrBuilder

Returns:

The kind.

getDisplayName

public String getDisplayName()

 The display name for the node.
 

string display_name = 3;

Specified by:

getDisplayName in interface PlanNodeOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public ByteString getDisplayNameBytes()

 The display name for the node.
 

string display_name = 3;

Specified by:

getDisplayNameBytes in interface PlanNodeOrBuilder

Returns:

The bytes for displayName.

getChildLinksList

public List<PlanNode.ChildLink> getChildLinksList()

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

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

Specified by:

getChildLinksList in interface PlanNodeOrBuilder

getChildLinksOrBuilderList

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

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

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

Specified by:

getChildLinksOrBuilderList in interface PlanNodeOrBuilder

getChildLinksCount

public int getChildLinksCount()

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

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

Specified by:

getChildLinksCount in interface PlanNodeOrBuilder

getChildLinks

public PlanNode.ChildLink getChildLinks(int index)

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

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

Specified by:

getChildLinks in interface PlanNodeOrBuilder

getChildLinksOrBuilder

public PlanNode.ChildLinkOrBuilder getChildLinksOrBuilder(int index)

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

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

Specified by:

getChildLinksOrBuilder in interface PlanNodeOrBuilder

hasShortRepresentation

public boolean hasShortRepresentation()

 Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
 

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

Specified by:

hasShortRepresentation in interface PlanNodeOrBuilder

Returns:

Whether the shortRepresentation field is set.

getShortRepresentation

public PlanNode.ShortRepresentation getShortRepresentation()

 Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
 

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

Specified by:

getShortRepresentation in interface PlanNodeOrBuilder

Returns:

The shortRepresentation.

getShortRepresentationOrBuilder

public PlanNode.ShortRepresentationOrBuilder getShortRepresentationOrBuilder()

 Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
 

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

Specified by:

getShortRepresentationOrBuilder in interface PlanNodeOrBuilder

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;

Specified by:

hasMetadata in interface PlanNodeOrBuilder

Returns:

Whether the metadata field is set.

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;

Specified by:

getMetadata in interface PlanNodeOrBuilder

Returns:

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;

Specified by:

getMetadataOrBuilder in interface PlanNodeOrBuilder

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;

Specified by:

hasExecutionStats in interface PlanNodeOrBuilder

Returns:

Whether the executionStats field is set.

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;

Specified by:

getExecutionStats in interface PlanNodeOrBuilder

Returns:

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;

Specified by:

getExecutionStatsOrBuilder in interface PlanNodeOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static PlanNode parseFrom(ByteBuffer data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PlanNode parseFrom(ByteBuffer data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PlanNode parseFrom(ByteString data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PlanNode parseFrom(ByteString data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PlanNode parseFrom(byte[] data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PlanNode parseFrom(byte[] data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PlanNode parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static PlanNode parseFrom(InputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static PlanNode parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static PlanNode parseDelimitedFrom(InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseFrom

public static PlanNode parseFrom(CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static PlanNode parseFrom(CodedInputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

newBuilderForType

public PlanNode.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static PlanNode.Builder newBuilder()

newBuilder

public static PlanNode.Builder newBuilder(PlanNode prototype)

toBuilder

public PlanNode.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected PlanNode.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static PlanNode getDefaultInstance()

parser

public static Parser<PlanNode> parser()

getParserForType

public Parser<PlanNode> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public PlanNode getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder