Package com.google.spanner.v1

Class PlanNode.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PlanNodeOrBuilder, Cloneable
    Enclosing class:
    PlanNode
    public static final class PlanNode.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>
implements PlanNodeOrBuilder
     Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
    Protobuf type google.spanner.v1.PlanNode

    • Method Detail

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

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public PlanNode.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • clearField

        public PlanNode.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • clearOneof

        public PlanNode.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • setRepeatedField

        public PlanNode.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • addRepeatedField

        public PlanNode.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • mergeFrom

        public PlanNode.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PlanNode.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • mergeFrom

        public PlanNode.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PlanNode.Builder>
        Throws:
        IOException

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

      • setIndex

        public PlanNode.Builder setIndex​(int value)
         The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
        int32 index = 1;
        Parameters:
        value - The index to set.
        Returns:
        This builder for chaining.

      • clearIndex

        public PlanNode.Builder clearIndex()
         The `PlanNode`'s index in [node list][google.spanner.v1.QueryPlan.plan_nodes].
        int32 index = 1;
        Returns:
        This builder for chaining.

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

      • setKindValue

        public PlanNode.Builder setKindValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for kind to set.
        Returns:
        This builder for chaining.

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

      • setKind

        public PlanNode.Builder setKind​(PlanNode.Kind value)
         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;
        Parameters:
        value - The kind to set.
        Returns:
        This builder for chaining.

      • clearKind

        public PlanNode.Builder clearKind()
         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:
        This builder for chaining.

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

      • setDisplayName

        public PlanNode.Builder setDisplayName​(String value)
         The display name for the node.
        string display_name = 3;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public PlanNode.Builder clearDisplayName()
         The display name for the node.
        string display_name = 3;
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public PlanNode.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         The display name for the node.
        string display_name = 3;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • 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

      • setChildLinks

        public PlanNode.Builder setChildLinks​(int index,
                                      PlanNode.ChildLink value)
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • setChildLinks

        public PlanNode.Builder setChildLinks​(int index,
                                      PlanNode.ChildLink.Builder builderForValue)
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • addChildLinks

        public PlanNode.Builder addChildLinks​(PlanNode.ChildLink value)
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • addChildLinks

        public PlanNode.Builder addChildLinks​(int index,
                                      PlanNode.ChildLink value)
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • addChildLinks

        public PlanNode.Builder addChildLinks​(PlanNode.ChildLink.Builder builderForValue)
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • addChildLinks

        public PlanNode.Builder addChildLinks​(int index,
                                      PlanNode.ChildLink.Builder builderForValue)
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • addAllChildLinks

        public PlanNode.Builder addAllChildLinks​(Iterable<? extends PlanNode.ChildLink> values)
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

      • clearChildLinks

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

      • removeChildLinks

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

      • getChildLinksBuilder

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

      • addChildLinksBuilder

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

      • addChildLinksBuilder

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

      • getChildLinksBuilderList

        public List<PlanNode.ChildLink.Builder> getChildLinksBuilderList()
         List of child node `index`es and their relationship to this parent.
        repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;

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

      • setShortRepresentation

        public PlanNode.Builder setShortRepresentation​(PlanNode.ShortRepresentation value)
         Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
        .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

      • setShortRepresentation

        public PlanNode.Builder setShortRepresentation​(PlanNode.ShortRepresentation.Builder builderForValue)
         Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
        .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

      • mergeShortRepresentation

        public PlanNode.Builder mergeShortRepresentation​(PlanNode.ShortRepresentation value)
         Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
        .google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

      • clearShortRepresentation

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

      • getShortRepresentationBuilder

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

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

      • setMetadata

        public PlanNode.Builder setMetadata​(com.google.protobuf.Struct value)
         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;

      • setMetadata

        public PlanNode.Builder setMetadata​(com.google.protobuf.Struct.Builder builderForValue)
         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;

      • mergeMetadata

        public PlanNode.Builder mergeMetadata​(com.google.protobuf.Struct value)
         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;

      • clearMetadata

        public PlanNode.Builder clearMetadata()
         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;

      • getMetadataBuilder

        public com.google.protobuf.Struct.Builder getMetadataBuilder()
         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;

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

      • setExecutionStats

        public PlanNode.Builder setExecutionStats​(com.google.protobuf.Struct value)
         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;

      • setExecutionStats

        public PlanNode.Builder setExecutionStats​(com.google.protobuf.Struct.Builder builderForValue)
         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;

      • mergeExecutionStats

        public PlanNode.Builder mergeExecutionStats​(com.google.protobuf.Struct value)
         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;

      • clearExecutionStats

        public PlanNode.Builder clearExecutionStats()
         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;

      • getExecutionStatsBuilder

        public com.google.protobuf.Struct.Builder getExecutionStatsBuilder()
         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;

      • 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

      • setUnknownFields

        public final PlanNode.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>

      • mergeUnknownFields

        public final PlanNode.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PlanNode.Builder>