Class PlanNode.Builder (6.72.0)

Version 6.72.0

• 6.82.0 (latest)
• 6.80.1
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

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

Implements

PlanNodeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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 indexes 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 indexes 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 indexes 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 indexes 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 indexes 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 indexes 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 indexes 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearChildLinks()

public PlanNode.Builder clearChildLinks()

List of child node indexes 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanNode.ChildLink

getChildLinksBuilder(int index)

public PlanNode.ChildLink.Builder getChildLinksBuilder(int index)

List of child node indexes 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 indexes 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 indexes 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 indexes 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 indexes 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 indexes 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public PlanNode.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
PlanNode.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeChildLinks(int index)

public PlanNode.Builder removeChildLinks(int index)

List of child node indexes 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 indexes 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 indexes 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)