Class PlanSummary.Builder (3.20.0)

Version 3.20.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class PlanSummary.Builder extends GeneratedMessageV3.Builder<PlanSummary.Builder> implements PlanSummaryOrBuilder

Planning phase information for the query.

Protobuf type google.firestore.v1.PlanSummary

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PlanSummary.Builder

Implements

PlanSummaryOrBuilder

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

addAllIndexesUsed(Iterable<? extends Struct> values)

public PlanSummary.Builder addAllIndexesUsed(Iterable<? extends Struct> values)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.protobuf.Struct>

Returns
Type	Description
PlanSummary.Builder

addIndexesUsed(Struct value)

public PlanSummary.Builder addIndexesUsed(Struct value)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
value	Struct

Returns
Type	Description
PlanSummary.Builder

addIndexesUsed(Struct.Builder builderForValue)

public PlanSummary.Builder addIndexesUsed(Struct.Builder builderForValue)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
PlanSummary.Builder

addIndexesUsed(int index, Struct value)

public PlanSummary.Builder addIndexesUsed(int index, Struct value)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameters
Name	Description
index	int
value	Struct

Returns
Type	Description
PlanSummary.Builder

addIndexesUsed(int index, Struct.Builder builderForValue)

public PlanSummary.Builder addIndexesUsed(int index, Struct.Builder builderForValue)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameters
Name	Description
index	int
builderForValue	Builder

Returns
Type	Description
PlanSummary.Builder

addIndexesUsedBuilder()

public Struct.Builder addIndexesUsedBuilder()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type	Description
Builder

addIndexesUsedBuilder(int index)

public Struct.Builder addIndexesUsedBuilder(int index)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PlanSummary.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
PlanSummary.Builder

Overrides

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

build()

public PlanSummary build()

Returns
Type	Description
PlanSummary

buildPartial()

public PlanSummary buildPartial()

Returns
Type	Description
PlanSummary

clear()

public PlanSummary.Builder clear()

Returns
Type	Description
PlanSummary.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public PlanSummary.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
PlanSummary.Builder

Overrides

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

clearIndexesUsed()

public PlanSummary.Builder clearIndexesUsed()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type	Description
PlanSummary.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PlanSummary.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
PlanSummary.Builder

Overrides

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

clone()

public PlanSummary.Builder clone()

Returns
Type	Description
PlanSummary.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public PlanSummary getDefaultInstanceForType()

Returns
Type	Description
PlanSummary

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getIndexesUsed(int index)

public Struct getIndexesUsed(int index)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Struct

getIndexesUsedBuilder(int index)

public Struct.Builder getIndexesUsedBuilder(int index)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Builder

getIndexesUsedBuilderList()

public List<Struct.Builder> getIndexesUsedBuilderList()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type	Description
List<Builder>

getIndexesUsedCount()

public int getIndexesUsedCount()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type	Description
int

getIndexesUsedList()

public List<Struct> getIndexesUsedList()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type	Description
List<Struct>

getIndexesUsedOrBuilder(int index)

public StructOrBuilder getIndexesUsedOrBuilder(int index)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
StructOrBuilder

getIndexesUsedOrBuilderList()

public List<? extends StructOrBuilder> getIndexesUsedOrBuilderList()

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Returns
Type	Description
List<? extends com.google.protobuf.StructOrBuilder>

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()

mergeFrom(PlanSummary other)

public PlanSummary.Builder mergeFrom(PlanSummary other)

Parameter
Name	Description
other	PlanSummary

Returns
Type	Description
PlanSummary.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PlanSummary.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PlanSummary.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public PlanSummary.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
PlanSummary.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PlanSummary.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PlanSummary.Builder

Overrides

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

removeIndexesUsed(int index)

public PlanSummary.Builder removeIndexesUsed(int index)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
PlanSummary.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PlanSummary.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
PlanSummary.Builder

Overrides

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

setIndexesUsed(int index, Struct value)

public PlanSummary.Builder setIndexesUsed(int index, Struct value)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameters
Name	Description
index	int
value	Struct

Returns
Type	Description
PlanSummary.Builder

setIndexesUsed(int index, Struct.Builder builderForValue)

public PlanSummary.Builder setIndexesUsed(int index, Struct.Builder builderForValue)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

repeated .google.protobuf.Struct indexes_used = 1;

Parameters
Name	Description
index	int
builderForValue	Builder

Returns
Type	Description
PlanSummary.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
PlanSummary.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final PlanSummary.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
PlanSummary.Builder

Overrides

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