Class QueryPlan.Builder (6.56.0)

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

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

Protobuf type google.spanner.v1.QueryPlan

Implements

QueryPlanOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.spanner.v1.PlanNode>
Returns
TypeDescription
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
NameDescription
valuePlanNode
Returns
TypeDescription
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
NameDescription
builderForValuePlanNode.Builder
Returns
TypeDescription
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
NameDescription
indexint
valuePlanNode
Returns
TypeDescription
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
NameDescription
indexint
builderForValuePlanNode.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
PlanNode.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QueryPlan.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueryPlan.Builder
Overrides

build()

public QueryPlan build()
Returns
TypeDescription
QueryPlan

buildPartial()

public QueryPlan buildPartial()
Returns
TypeDescription
QueryPlan

clear()

public QueryPlan.Builder clear()
Returns
TypeDescription
QueryPlan.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public QueryPlan.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
QueryPlan.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryPlan.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
QueryPlan.Builder
Overrides

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

clone()

public QueryPlan.Builder clone()
Returns
TypeDescription
QueryPlan.Builder
Overrides

getDefaultInstanceForType()

public QueryPlan getDefaultInstanceForType()
Returns
TypeDescription
QueryPlan

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.spanner.v1.PlanNodeOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryPlan.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryPlan.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public QueryPlan.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
QueryPlan.Builder
Overrides

mergeFrom(QueryPlan other)

public QueryPlan.Builder mergeFrom(QueryPlan other)
Parameter
NameDescription
otherQueryPlan
Returns
TypeDescription
QueryPlan.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryPlan.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueryPlan.Builder
Overrides

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
NameDescription
indexint
Returns
TypeDescription
QueryPlan.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public QueryPlan.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QueryPlan.Builder
Overrides

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
NameDescription
indexint
valuePlanNode
Returns
TypeDescription
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
NameDescription
indexint
builderForValuePlanNode.Builder
Returns
TypeDescription
QueryPlan.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QueryPlan.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
QueryPlan.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryPlan.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QueryPlan.Builder
Overrides