Package com.google.spanner.v1

Class PlanNode

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PlanNodeOrBuilder, Serializable
    public final class PlanNode
extends com.google.protobuf.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 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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.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 com.google.protobuf.ByteString getDisplayNameBytes()
         The display name for the node.
        string display_name = 3;
        Specified by:
        getDisplayNameBytes in interface PlanNodeOrBuilder
        Returns:
        The bytes for displayName.

      • 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

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

      • 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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static PlanNode parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlanNode parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlanNode parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlanNode parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlanNode parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlanNode parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static PlanNode parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public PlanNode.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public PlanNode.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected PlanNode.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static PlanNode getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<PlanNode> parser()

      • getParserForType

        public com.google.protobuf.Parser<PlanNode> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public PlanNode getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder