Package com.google.spanner.v1

Class QueryPlan.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<QueryPlan.Builder>
com.google.spanner.v1.QueryPlan.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryPlanOrBuilder, Cloneable
Enclosing class:
QueryPlan
public static final class QueryPlan.Builder extends com.google.protobuf.GeneratedMessage.Builder<QueryPlan.Builder> implements QueryPlanOrBuilder
 Contains an ordered list of nodes appearing in the query plan.
Protobuf type google.spanner.v1.QueryPlan

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<QueryPlan.Builder>

    • clear

      public QueryPlan.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.GeneratedMessage.Builder<QueryPlan.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.GeneratedMessage.Builder<QueryPlan.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public QueryPlan.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<QueryPlan.Builder>

    • mergeFrom

      public QueryPlan.Builder mergeFrom(QueryPlan other)

    • isInitialized

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

    • mergeFrom

      public QueryPlan.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<QueryPlan.Builder>
      Throws:
      IOException

    • getPlanNodesList

      public List<PlanNode> getPlanNodesList()
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;
      Specified by:
      getPlanNodesList in interface QueryPlanOrBuilder

    • getPlanNodesCount

      public int getPlanNodesCount()
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;
      Specified by:
      getPlanNodesCount in interface QueryPlanOrBuilder

    • getPlanNodes

      public PlanNode getPlanNodes(int index)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;
      Specified by:
      getPlanNodes in interface QueryPlanOrBuilder

    • setPlanNodes

      public QueryPlan.Builder setPlanNodes(int index, PlanNode value)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • setPlanNodes

      public QueryPlan.Builder setPlanNodes(int index, PlanNode.Builder builderForValue)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • addPlanNodes

      public QueryPlan.Builder addPlanNodes(PlanNode value)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • addPlanNodes

      public QueryPlan.Builder addPlanNodes(int index, PlanNode value)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • addPlanNodes

      public QueryPlan.Builder addPlanNodes(PlanNode.Builder builderForValue)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • addPlanNodes

      public QueryPlan.Builder addPlanNodes(int index, PlanNode.Builder builderForValue)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • addAllPlanNodes

      public QueryPlan.Builder addAllPlanNodes(Iterable<? extends PlanNode> values)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • clearPlanNodes

      public QueryPlan.Builder clearPlanNodes()
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • removePlanNodes

      public QueryPlan.Builder removePlanNodes(int index)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • getPlanNodesBuilder

      public PlanNode.Builder getPlanNodesBuilder(int index)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • getPlanNodesOrBuilder

      public PlanNodeOrBuilder getPlanNodesOrBuilder(int index)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;
      Specified by:
      getPlanNodesOrBuilder in interface QueryPlanOrBuilder

    • getPlanNodesOrBuilderList

      public List<? extends PlanNodeOrBuilder> getPlanNodesOrBuilderList()
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;
      Specified by:
      getPlanNodesOrBuilderList in interface QueryPlanOrBuilder

    • addPlanNodesBuilder

      public PlanNode.Builder addPlanNodesBuilder()
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • addPlanNodesBuilder

      public PlanNode.Builder addPlanNodesBuilder(int index)
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • getPlanNodesBuilderList

      public List<PlanNode.Builder> getPlanNodesBuilderList()
       The nodes in the query plan. Plan nodes are returned in pre-order starting
 with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s `id`
 corresponds to its index in `plan_nodes`.
      repeated .google.spanner.v1.PlanNode plan_nodes = 1;

    • hasQueryAdvice

      public boolean hasQueryAdvice()
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasQueryAdvice in interface QueryPlanOrBuilder
      Returns:
      Whether the queryAdvice field is set.

    • getQueryAdvice

      public QueryAdvisorResult getQueryAdvice()
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQueryAdvice in interface QueryPlanOrBuilder
      Returns:
      The queryAdvice.

    • setQueryAdvice

      public QueryPlan.Builder setQueryAdvice(QueryAdvisorResult value)
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];

    • setQueryAdvice

      public QueryPlan.Builder setQueryAdvice(QueryAdvisorResult.Builder builderForValue)
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];

    • mergeQueryAdvice

      public QueryPlan.Builder mergeQueryAdvice(QueryAdvisorResult value)
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];

    • clearQueryAdvice

      public QueryPlan.Builder clearQueryAdvice()
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getQueryAdviceBuilder

      public QueryAdvisorResult.Builder getQueryAdviceBuilder()
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getQueryAdviceOrBuilder

      public QueryAdvisorResultOrBuilder getQueryAdviceOrBuilder()
       Optional. The advise/recommendations for a query. Currently this field will
 be serving index recommendations for a query.
      .google.spanner.v1.QueryAdvisorResult query_advice = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQueryAdviceOrBuilder in interface QueryPlanOrBuilder