Class QueryPlan (6.69.0)

public final class QueryPlan extends GeneratedMessageV3 implements QueryPlanOrBuilder

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

Protobuf type google.spanner.v1.QueryPlan

Implements

QueryPlanOrBuilder

Static Fields

PLAN_NODES_FIELD_NUMBER

public static final int PLAN_NODES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryPlan getDefaultInstance()
Returns
Type Description
QueryPlan

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static QueryPlan.Builder newBuilder()
Returns
Type Description
QueryPlan.Builder

newBuilder(QueryPlan prototype)

public static QueryPlan.Builder newBuilder(QueryPlan prototype)
Parameter
Name Description
prototype QueryPlan
Returns
Type Description
QueryPlan.Builder

parseDelimitedFrom(InputStream input)

public static QueryPlan parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryPlan
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryPlan
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QueryPlan parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueryPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryPlan parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryPlan parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryPlan
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryPlan
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QueryPlan parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryPlan
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryPlan
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QueryPlan parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryPlan
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QueryPlan> parser()
Returns
Type Description
Parser<QueryPlan>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public QueryPlan getDefaultInstanceForType()
Returns
Type Description
QueryPlan

getParserForType()

public Parser<QueryPlan> getParserForType()
Returns
Type Description
Parser<QueryPlan>
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
Name Description
index int
Returns
Type Description
PlanNode

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QueryPlan.Builder newBuilderForType()
Returns
Type Description
QueryPlan.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QueryPlan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryPlan.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public QueryPlan.Builder toBuilder()
Returns
Type Description
QueryPlan.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException