Class QueryPlan (6.54.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
TypeDescription
int

Static Methods

getDefaultInstance()

public static QueryPlan getDefaultInstance()
Returns
TypeDescription
QueryPlan

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static QueryPlan.Builder newBuilder()
Returns
TypeDescription
QueryPlan.Builder

newBuilder(QueryPlan prototype)

public static QueryPlan.Builder newBuilder(QueryPlan prototype)
Parameter
NameDescription
prototypeQueryPlan
Returns
TypeDescription
QueryPlan.Builder

parseDelimitedFrom(InputStream input)

public static QueryPlan parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static QueryPlan parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryPlan parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryPlan parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static QueryPlan parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static QueryPlan parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryPlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QueryPlan
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<QueryPlan> parser()
Returns
TypeDescription
Parser<QueryPlan>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public QueryPlan getDefaultInstanceForType()
Returns
TypeDescription
QueryPlan

getParserForType()

public Parser<QueryPlan> getParserForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
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>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public QueryPlan.Builder newBuilderForType()
Returns
TypeDescription
QueryPlan.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QueryPlan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
QueryPlan.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public QueryPlan.Builder toBuilder()
Returns
TypeDescription
QueryPlan.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException