Package com.google.spanner.v1

Interface PlanNodeOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    PlanNode, PlanNode.Builder
    public interface PlanNodeOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getIndex

        int getIndex()
         The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
        int32 index = 1;
        Returns:
        The index.

      • getKindValue

        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;
        Returns:
        The enum numeric value on the wire for kind.

      • getKind

        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;
        Returns:
        The kind.

      • getDisplayName

        String getDisplayName()
         The display name for the node.
        string display_name = 3;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         The display name for the node.
        string display_name = 3;
        Returns:
        The bytes for displayName.

      • getChildLinksList

        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;

      • getChildLinks

        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;

      • getChildLinksCount

        int getChildLinksCount()
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • getChildLinksOrBuilderList

        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;

      • getChildLinksOrBuilder

        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;

      • hasShortRepresentation

        boolean hasShortRepresentation()
         Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
        .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
        Returns:
        Whether the shortRepresentation field is set.

      • getShortRepresentation

        PlanNode.ShortRepresentation getShortRepresentation()
         Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
        .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
        Returns:
        The shortRepresentation.

      • getShortRepresentationOrBuilder

        PlanNode.ShortRepresentationOrBuilder getShortRepresentationOrBuilder()
         Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
        .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

      • hasMetadata

        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:
        Whether the metadata field is set.

      • getMetadata

        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;
        Returns:
        The metadata.

      • getMetadataOrBuilder

        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;

      • hasExecutionStats

        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:
        Whether the executionStats field is set.

      • getExecutionStats

        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;
        Returns:
        The executionStats.

      • getExecutionStatsOrBuilder

        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;