Class PlanNode.Builder (6.55.0)

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

Implements

PlanNodeOrBuilder

Static Methods

getDescriptor()

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

Methods

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
NameDescription
valuesIterable<? extends com.google.spanner.v1.PlanNode.ChildLink>
Returns
TypeDescription
PlanNode.Builder
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
NameDescription
valuePlanNode.ChildLink
Returns
TypeDescription
PlanNode.Builder
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
NameDescription
builderForValuePlanNode.ChildLink.Builder
Returns
TypeDescription
PlanNode.Builder
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
NameDescription
indexint
valuePlanNode.ChildLink
Returns
TypeDescription
PlanNode.Builder
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
NameDescription
indexint
builderForValuePlanNode.ChildLink.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
PlanNode.ChildLink.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PlanNode.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PlanNode.Builder
Overrides

build()

public PlanNode build()
Returns
TypeDescription
PlanNode

buildPartial()

public PlanNode buildPartial()
Returns
TypeDescription
PlanNode

clear()

public PlanNode.Builder clear()
Returns
TypeDescription
PlanNode.Builder
Overrides
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
TypeDescription
PlanNode.Builder

clearDisplayName()

public PlanNode.Builder clearDisplayName()

The display name for the node.

string display_name = 3;

Returns
TypeDescription
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
TypeDescription
PlanNode.Builder

clearField(Descriptors.FieldDescriptor field)

public PlanNode.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PlanNode.Builder
Overrides

clearIndex()

public PlanNode.Builder clearIndex()

The PlanNode's index in node list.

int32 index = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
PlanNode.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PlanNode.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PlanNode.Builder
Overrides

clearShortRepresentation()

public PlanNode.Builder clearShortRepresentation()

Condensed representation for SCALAR nodes.

.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

Returns
TypeDescription
PlanNode.Builder

clone()

public PlanNode.Builder clone()
Returns
TypeDescription
PlanNode.Builder
Overrides
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.spanner.v1.PlanNode.ChildLinkOrBuilder>

getDefaultInstanceForType()

public PlanNode getDefaultInstanceForType()
Returns
TypeDescription
PlanNode

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

The display name for the node.

string display_name = 3;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name for the node.

string display_name = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
StructOrBuilder

getIndex()

public int getIndex()

The PlanNode's index in node list.

int32 index = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
StructOrBuilder

getShortRepresentation()

public PlanNode.ShortRepresentation getShortRepresentation()

Condensed representation for SCALAR nodes.

.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

Returns
TypeDescription
PlanNode.ShortRepresentation

The shortRepresentation.

getShortRepresentationBuilder()

public PlanNode.ShortRepresentation.Builder getShortRepresentationBuilder()

Condensed representation for SCALAR nodes.

.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

Returns
TypeDescription
PlanNode.ShortRepresentation.Builder

getShortRepresentationOrBuilder()

public PlanNode.ShortRepresentationOrBuilder getShortRepresentationOrBuilder()

Condensed representation for SCALAR nodes.

.google.spanner.v1.PlanNode.ShortRepresentation short_representation = 5;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the shortRepresentation field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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
NameDescription
valueStruct
Returns
TypeDescription
PlanNode.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PlanNode.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PlanNode.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PlanNode.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PlanNode.Builder
Overrides

mergeFrom(PlanNode other)

public PlanNode.Builder mergeFrom(PlanNode other)
Parameter
NameDescription
otherPlanNode
Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
valuePlanNode.ShortRepresentation
Returns
TypeDescription
PlanNode.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PlanNode.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PlanNode.Builder
Overrides
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
NameDescription
indexint
Returns
TypeDescription
PlanNode.Builder
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
NameDescription
indexint
valuePlanNode.ChildLink
Returns
TypeDescription
PlanNode.Builder
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
NameDescription
indexint
builderForValuePlanNode.ChildLink.Builder
Returns
TypeDescription
PlanNode.Builder

setDisplayName(String value)

public PlanNode.Builder setDisplayName(String value)

The display name for the node.

string display_name = 3;

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
PlanNode.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PlanNode.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PlanNode.Builder
Overrides

setIndex(int value)

public PlanNode.Builder setIndex(int value)

The PlanNode's index in node list.

int32 index = 1;

Parameter
NameDescription
valueint

The index to set.

Returns
TypeDescription
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
NameDescription
valuePlanNode.Kind

The kind to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for kind to set.

Returns
TypeDescription
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
NameDescription
valueStruct
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
PlanNode.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PlanNode.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PlanNode.Builder
Overrides

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
NameDescription
valuePlanNode.ShortRepresentation
Returns
TypeDescription
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
NameDescription
builderForValuePlanNode.ShortRepresentation.Builder
Returns
TypeDescription
PlanNode.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PlanNode.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PlanNode.Builder
Overrides