public static final class PlanNode.Builder extends GeneratedMessageV3.Builder<PlanNode.Builder> implements PlanNodeOrBuilder
Node information for nodes appearing in a QueryPlan.plan_nodes.
Protobuf type google.spanner.v1.PlanNode
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PlanNode.BuilderImplements
PlanNodeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllChildLinks(Iterable<? extends PlanNode.ChildLink> values)
public PlanNode.Builder addAllChildLinks(Iterable<? extends PlanNode.ChildLink> values)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.spanner.v1.PlanNode.ChildLink> |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
addChildLinks(PlanNode.ChildLink value)
public PlanNode.Builder addChildLinks(PlanNode.ChildLink value)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
value |
PlanNode.ChildLink |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
addChildLinks(PlanNode.ChildLink.Builder builderForValue)
public PlanNode.Builder addChildLinks(PlanNode.ChildLink.Builder builderForValue)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
builderForValue |
PlanNode.ChildLink.Builder |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
addChildLinks(int index, PlanNode.ChildLink value)
public PlanNode.Builder addChildLinks(int index, PlanNode.ChildLink value)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
PlanNode.ChildLink |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
addChildLinks(int index, PlanNode.ChildLink.Builder builderForValue)
public PlanNode.Builder addChildLinks(int index, PlanNode.ChildLink.Builder builderForValue)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
PlanNode.ChildLink.Builder |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
addChildLinksBuilder()
public PlanNode.ChildLink.Builder addChildLinksBuilder()
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Returns | |
---|---|
Type | Description |
PlanNode.ChildLink.Builder |
addChildLinksBuilder(int index)
public PlanNode.ChildLink.Builder addChildLinksBuilder(int index)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PlanNode.ChildLink.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PlanNode.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
build()
public PlanNode build()
Returns | |
---|---|
Type | Description |
PlanNode |
buildPartial()
public PlanNode buildPartial()
Returns | |
---|---|
Type | Description |
PlanNode |
clear()
public PlanNode.Builder clear()
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
clearChildLinks()
public PlanNode.Builder clearChildLinks()
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
clearDisplayName()
public PlanNode.Builder clearDisplayName()
The display name for the node.
string display_name = 3;
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
clearExecutionStats()
public PlanNode.Builder clearExecutionStats()
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;
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
clearField(Descriptors.FieldDescriptor field)
public PlanNode.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
clearIndex()
public PlanNode.Builder clearIndex()
The PlanNode
's index in node list.
int32 index = 1;
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
clearKind()
public PlanNode.Builder clearKind()
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;
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
clearMetadata()
public PlanNode.Builder clearMetadata()
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;
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public PlanNode.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
clearShortRepresentation()
public PlanNode.Builder clearShortRepresentation()
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
clone()
public PlanNode.Builder clone()
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
getChildLinks(int index)
public PlanNode.ChildLink getChildLinks(int index)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PlanNode.ChildLink |
getChildLinksBuilder(int index)
public PlanNode.ChildLink.Builder getChildLinksBuilder(int index)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PlanNode.ChildLink.Builder |
getChildLinksBuilderList()
public List<PlanNode.ChildLink.Builder> getChildLinksBuilderList()
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Returns | |
---|---|
Type | Description |
List<Builder> |
getChildLinksCount()
public int getChildLinksCount()
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Returns | |
---|---|
Type | Description |
int |
getChildLinksList()
public List<PlanNode.ChildLink> getChildLinksList()
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Returns | |
---|---|
Type | Description |
List<ChildLink> |
getChildLinksOrBuilder(int index)
public PlanNode.ChildLinkOrBuilder getChildLinksOrBuilder(int index)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PlanNode.ChildLinkOrBuilder |
getChildLinksOrBuilderList()
public List<? extends PlanNode.ChildLinkOrBuilder> getChildLinksOrBuilderList()
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Returns | |
---|---|
Type | Description |
List<? extends com.google.spanner.v1.PlanNode.ChildLinkOrBuilder> |
getDefaultInstanceForType()
public PlanNode getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
PlanNode |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getDisplayName()
public String getDisplayName()
The display name for the node.
string display_name = 3;
Returns | |
---|---|
Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
The display name for the node.
string display_name = 3;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
Struct |
The executionStats. |
getExecutionStatsBuilder()
public Struct.Builder getExecutionStatsBuilder()
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;
Returns | |
---|---|
Type | Description |
Builder |
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;
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getIndex()
public int getIndex()
The PlanNode
's index in node list.
int32 index = 1;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
PlanNode.Kind |
The kind. |
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;
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for kind. |
getMetadata()
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;
Returns | |
---|---|
Type | Description |
Struct |
The metadata. |
getMetadataBuilder()
public Struct.Builder getMetadataBuilder()
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;
Returns | |
---|---|
Type | Description |
Builder |
getMetadataOrBuilder()
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;
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getShortRepresentation()
public PlanNode.ShortRepresentation getShortRepresentation()
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
Returns | |
---|---|
Type | Description |
PlanNode.ShortRepresentation |
The shortRepresentation. |
getShortRepresentationBuilder()
public PlanNode.ShortRepresentation.Builder getShortRepresentationBuilder()
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
Returns | |
---|---|
Type | Description |
PlanNode.ShortRepresentation.Builder |
getShortRepresentationOrBuilder()
public PlanNode.ShortRepresentationOrBuilder getShortRepresentationOrBuilder()
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
Returns | |
---|---|
Type | Description |
PlanNode.ShortRepresentationOrBuilder |
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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the executionStats field is set. |
hasMetadata()
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;
Returns | |
---|---|
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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the shortRepresentation field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeExecutionStats(Struct value)
public PlanNode.Builder mergeExecutionStats(Struct value)
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;
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PlanNode.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public PlanNode.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
mergeFrom(PlanNode other)
public PlanNode.Builder mergeFrom(PlanNode other)
Parameter | |
---|---|
Name | Description |
other |
PlanNode |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
mergeMetadata(Struct value)
public PlanNode.Builder mergeMetadata(Struct value)
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;
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
mergeShortRepresentation(PlanNode.ShortRepresentation value)
public PlanNode.Builder mergeShortRepresentation(PlanNode.ShortRepresentation value)
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
Parameter | |
---|---|
Name | Description |
value |
PlanNode.ShortRepresentation |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PlanNode.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
removeChildLinks(int index)
public PlanNode.Builder removeChildLinks(int index)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setChildLinks(int index, PlanNode.ChildLink value)
public PlanNode.Builder setChildLinks(int index, PlanNode.ChildLink value)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
value |
PlanNode.ChildLink |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setChildLinks(int index, PlanNode.ChildLink.Builder builderForValue)
public PlanNode.Builder setChildLinks(int index, PlanNode.ChildLink.Builder builderForValue)
List of child node index
es and their relationship to this parent.
repeated .google.spanner.v1.PlanNode.ChildLink child_links = 4;
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
PlanNode.ChildLink.Builder |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setDisplayName(String value)
public PlanNode.Builder setDisplayName(String value)
The display name for the node.
string display_name = 3;
Parameter | |
---|---|
Name | Description |
value |
String The displayName to set. |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public PlanNode.Builder setDisplayNameBytes(ByteString value)
The display name for the node.
string display_name = 3;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for displayName to set. |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
setExecutionStats(Struct value)
public PlanNode.Builder setExecutionStats(Struct value)
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;
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setExecutionStats(Struct.Builder builderForValue)
public PlanNode.Builder setExecutionStats(Struct.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public PlanNode.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setIndex(int value)
public PlanNode.Builder setIndex(int value)
The PlanNode
's index in node list.
int32 index = 1;
Parameter | |
---|---|
Name | Description |
value |
int The index to set. |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
setKind(PlanNode.Kind value)
public PlanNode.Builder setKind(PlanNode.Kind value)
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;
Parameter | |
---|---|
Name | Description |
value |
PlanNode.Kind The kind to set. |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
setKindValue(int value)
public PlanNode.Builder setKindValue(int value)
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;
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for kind to set. |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
This builder for chaining. |
setMetadata(Struct value)
public PlanNode.Builder setMetadata(Struct value)
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;
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setMetadata(Struct.Builder builderForValue)
public PlanNode.Builder setMetadata(Struct.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PlanNode.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setShortRepresentation(PlanNode.ShortRepresentation value)
public PlanNode.Builder setShortRepresentation(PlanNode.ShortRepresentation value)
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
Parameter | |
---|---|
Name | Description |
value |
PlanNode.ShortRepresentation |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setShortRepresentation(PlanNode.ShortRepresentation.Builder builderForValue)
public PlanNode.Builder setShortRepresentation(PlanNode.ShortRepresentation.Builder builderForValue)
Condensed representation for SCALAR nodes.
.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;
Parameter | |
---|---|
Name | Description |
builderForValue |
PlanNode.ShortRepresentation.Builder |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PlanNode.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PlanNode.Builder |