Package 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:
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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    PlanNode.Builder
    Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
    static final class 
    PlanNode.ChildLink
    Metadata associated with a parent-child relationship appearing in a [PlanNode][google.spanner.v1.PlanNode].
    static interface 
    PlanNode.ChildLinkOrBuilder
     
    static enum 
    PlanNode.Kind
    The kind of [PlanNode][google.spanner.v1.PlanNode].
    static final 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CHILD_LINKS_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    EXECUTION_STATS_FIELD_NUMBER
     
    static final int
    INDEX_FIELD_NUMBER
     
    static final int
    KIND_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final 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
    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 final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    The display name for the node.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    The display name for the node.
    com.google.protobuf.Struct
    getExecutionStats()
    The execution statistics associated with the node, contained in a group of key-value pairs.
    com.google.protobuf.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.
    com.google.protobuf.Struct
    getMetadata()
    Attributes relevant to the node contained in a group of key-value pairs.
    com.google.protobuf.StructOrBuilder
    getMetadataOrBuilder()
    Attributes relevant to the node contained in a group of key-value pairs.
    com.google.protobuf.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.
    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 com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static PlanNode.Builder
    newBuilder()
     
    static PlanNode.Builder
    newBuilder(PlanNode prototype)
     
    PlanNode.Builder
    newBuilderForType()
     
    protected PlanNode.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static PlanNode
    parseDelimitedFrom(InputStream input)
     
    static PlanNode
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PlanNode
    parseFrom(byte[] data)
     
    static PlanNode
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PlanNode
    parseFrom(com.google.protobuf.ByteString data)
     
    static PlanNode
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PlanNode
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PlanNode
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PlanNode
    parseFrom(InputStream input)
     
    static PlanNode
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PlanNode
    parseFrom(ByteBuffer data)
     
    static PlanNode
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PlanNode>
    parser()
     
    PlanNode.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • INDEX_FIELD_NUMBER

      public static final int INDEX_FIELD_NUMBER
      See Also:

    • KIND_FIELD_NUMBER

      public static final int KIND_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • SHORT_REPRESENTATION_FIELD_NUMBER

      public static final int SHORT_REPRESENTATION_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • EXECUTION_STATS_FIELD_NUMBER

      public static final int EXECUTION_STATS_FIELD_NUMBER
      See Also:

  • Method Details

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

    • 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 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static PlanNode parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static PlanNode parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static PlanNode.Builder newBuilder()

    • newBuilder

      public static PlanNode.Builder newBuilder(PlanNode prototype)

    • 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