public final class PlanNode extends GeneratedMessageV3 implements PlanNodeOrBuilder
Node information for nodes appearing in a QueryPlan.plan_nodes.
Protobuf type google.spanner.v1.PlanNode
Fields
CHILD_LINKS_FIELD_NUMBER
public static final int CHILD_LINKS_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
EXECUTION_STATS_FIELD_NUMBER
public static final int EXECUTION_STATS_FIELD_NUMBER
Field Value
INDEX_FIELD_NUMBER
public static final int INDEX_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
SHORT_REPRESENTATION_FIELD_NUMBER
public static final int SHORT_REPRESENTATION_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getChildLinks(int index)
public PlanNode.ChildLink getChildLinks(int index)
List of child node indexes and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
getChildLinksCount()
public int getChildLinksCount()
List of child node indexes and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
getChildLinksList()
public List<PlanNode.ChildLink> getChildLinksList()
List of child node indexes and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
getChildLinksOrBuilder(int index)
public PlanNode.ChildLinkOrBuilder getChildLinksOrBuilder(int index)
List of child node indexes and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
getChildLinksOrBuilderList()
public List<? extends PlanNode.ChildLinkOrBuilder> getChildLinksOrBuilderList()
List of child node indexes and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
| Type | Description |
| List<? extends com.google.spanner.v1.PlanNode.ChildLinkOrBuilder> | |
getDefaultInstance()
public static PlanNode getDefaultInstance()
Returns
getDefaultInstanceForType()
public PlanNode getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDisplayName()
public String getDisplayName()
The display name for the node.
string display_name = 3;
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name for the node.
string display_name = 3;
| Type | Description |
| ByteString | The bytes for displayName.
|
getExecutionStats()
public Struct getExecutionStats()
The execution statistics associated with the node, contained in a group of
key-value pairs. Only present if the plan was returned as a result of a
profile query. For example, number of executions, number of rows/time per
execution etc.
.google.protobuf.Struct execution_stats = 7;
| Type | Description |
| Struct | The executionStats.
|
getExecutionStatsOrBuilder()
public StructOrBuilder getExecutionStatsOrBuilder()
The execution statistics associated with the node, contained in a group of
key-value pairs. Only present if the plan was returned as a result of a
profile query. For example, number of executions, number of rows/time per
execution etc.
.google.protobuf.Struct execution_stats = 7;
getIndex()
The PlanNode's index in node list.
int32 index = 1;
| Type | Description |
| int | The index.
|
getKind()
public PlanNode.Kind getKind()
Used to determine the type of node. May be needed for visualizing
different kinds of nodes differently. For example, If the node is a
SCALAR node, it will have a condensed representation
which can be used to directly embed a description of the node in its
parent.
.google.spanner.v1.PlanNode.Kind kind = 2;
getKindValue()
public int getKindValue()
Used to determine the type of node. May be needed for visualizing
different kinds of nodes differently. For example, If the node is a
SCALAR node, it will have a condensed representation
which can be used to directly embed a description of the node in its
parent.
.google.spanner.v1.PlanNode.Kind kind = 2;
| Type | Description |
| int | The enum numeric value on the wire for kind.
|
public Struct getMetadata()
Attributes relevant to the node contained in a group of key-value pairs.
For example, a Parameter Reference node could have the following
information in its metadata:
{
"parameter_reference": "param1",
"parameter_type": "array"
}
.google.protobuf.Struct metadata = 6;
| Type | Description |
| Struct | The metadata.
|
public StructOrBuilder getMetadataOrBuilder()
Attributes relevant to the node contained in a group of key-value pairs.
For example, a Parameter Reference node could have the following
information in its metadata:
{
"parameter_reference": "param1",
"parameter_type": "array"
}
.google.protobuf.Struct metadata = 6;
getParserForType()
public Parser<PlanNode> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getShortRepresentation()
public PlanNode.ShortRepresentation getShortRepresentation()
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
getShortRepresentationOrBuilder()
public PlanNode.ShortRepresentationOrBuilder getShortRepresentationOrBuilder()
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasExecutionStats()
public boolean hasExecutionStats()
The execution statistics associated with the node, contained in a group of
key-value pairs. Only present if the plan was returned as a result of a
profile query. For example, number of executions, number of rows/time per
execution etc.
.google.protobuf.Struct execution_stats = 7;
| Type | Description |
| boolean | Whether the executionStats field is set.
|
public boolean hasMetadata()
Attributes relevant to the node contained in a group of key-value pairs.
For example, a Parameter Reference node could have the following
information in its metadata:
{
"parameter_reference": "param1",
"parameter_type": "array"
}
.google.protobuf.Struct metadata = 6;
| Type | Description |
| boolean | Whether the metadata field is set.
|
hasShortRepresentation()
public boolean hasShortRepresentation()
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
| Type | Description |
| boolean | Whether the shortRepresentation field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static PlanNode.Builder newBuilder()
Returns
newBuilder(PlanNode prototype)
public static PlanNode.Builder newBuilder(PlanNode prototype)
Parameter
Returns
newBuilderForType()
public PlanNode.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PlanNode.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static PlanNode parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static PlanNode parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PlanNode parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PlanNode parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PlanNode parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PlanNode parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PlanNode parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static PlanNode parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static PlanNode parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static PlanNode parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PlanNode parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PlanNode parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<PlanNode> parser()
Returns
toBuilder()
public PlanNode.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
