Class QueryPlan.Builder (6.108.0)

Version latest

• 6.108.0 (latest)
• 6.107.0
• 6.103.0
• 6.102.1
• 6.101.1
• 6.100.0
• 6.99.0
• 6.98.1
• 6.97.1
• 6.96.1
• 6.95.1
• 6.94.0
• 6.93.0
• 6.89.0
• 6.88.0
• 6.87.0
• 6.86.0
• 6.85.0
• 6.83.0
• 6.82.0
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public static final class QueryPlan.Builder extends GeneratedMessage.Builder<QueryPlan.Builder> implements QueryPlanOrBuilder

Contains an ordered list of nodes appearing in the query plan.

Protobuf type google.spanner.v1.QueryPlan

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > QueryPlan.Builder

Implements

QueryPlanOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllPlanNodes(Iterable<? extends PlanNode> values)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.spanner.v1.PlanNode>

Returns
Type	Description
QueryPlan.Builder

addPlanNodes(PlanNode value)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
value	PlanNode

Returns
Type	Description
QueryPlan.Builder

addPlanNodes(PlanNode.Builder builderForValue)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
builderForValue	PlanNode.Builder

Returns
Type	Description
QueryPlan.Builder

addPlanNodes(int index, PlanNode value)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameters
Name	Description
index	int
value	PlanNode

Returns
Type	Description
QueryPlan.Builder

addPlanNodes(int index, PlanNode.Builder builderForValue)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameters
Name	Description
index	int
builderForValue	PlanNode.Builder

Returns
Type	Description
QueryPlan.Builder

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Returns
Type	Description
PlanNode.Builder

addPlanNodesBuilder(int index)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanNode.Builder

build()

public QueryPlan build()

Returns
Type	Description
QueryPlan

buildPartial()

public QueryPlan buildPartial()

Returns
Type	Description
QueryPlan

clear()

public QueryPlan.Builder clear()

Returns
Type	Description
QueryPlan.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Returns
Type	Description
QueryPlan.Builder

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];

Returns
Type	Description
QueryPlan.Builder

getDefaultInstanceForType()

public QueryPlan getDefaultInstanceForType()

Returns
Type	Description
QueryPlan

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getPlanNodes(int index)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanNode

getPlanNodesBuilder(int index)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanNode.Builder

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Returns
Type	Description
List<Builder>

getPlanNodesCount()

public int getPlanNodesCount()

The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Returns
Type	Description
int

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Returns
Type	Description
List<PlanNode>

getPlanNodesOrBuilder(int index)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanNodeOrBuilder

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Returns
Type	Description
List<? extends com.google.spanner.v1.PlanNodeOrBuilder>

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];

Returns
Type	Description
QueryAdvisorResult	The queryAdvice.

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];

Returns
Type	Description
QueryAdvisorResult.Builder

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];

Returns
Type	Description
QueryAdvisorResultOrBuilder

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];

Returns
Type	Description
boolean	Whether the queryAdvice field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryPlan.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryPlan.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public QueryPlan.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
QueryPlan.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(QueryPlan other)

public QueryPlan.Builder mergeFrom(QueryPlan other)

Parameter
Name	Description
other	QueryPlan

Returns
Type	Description
QueryPlan.Builder

mergeQueryAdvice(QueryAdvisorResult value)

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];

Parameter
Name	Description
value	QueryAdvisorResult

Returns
Type	Description
QueryPlan.Builder

removePlanNodes(int index)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
QueryPlan.Builder

setPlanNodes(int index, PlanNode value)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameters
Name	Description
index	int
value	PlanNode

Returns
Type	Description
QueryPlan.Builder

setPlanNodes(int index, PlanNode.Builder builderForValue)

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's id corresponds to its index in plan_nodes.

repeated .google.spanner.v1.PlanNode plan_nodes = 1;

Parameters
Name	Description
index	int
builderForValue	PlanNode.Builder

Returns
Type	Description
QueryPlan.Builder

setQueryAdvice(QueryAdvisorResult value)

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];

Parameter
Name	Description
value	QueryAdvisorResult

Returns
Type	Description
QueryPlan.Builder

setQueryAdvice(QueryAdvisorResult.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	QueryAdvisorResult.Builder

Returns
Type	Description
QueryPlan.Builder