Class Cursor.Builder (3.21.3)

Version 3.21.3

• 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 Cursor.Builder extends GeneratedMessageV3.Builder<Cursor.Builder> implements CursorOrBuilder

A position in a query result set.

Protobuf type google.firestore.v1.Cursor

Inheritance

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

Implements

CursorOrBuilder

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

addAllValues(Iterable<? extends Value> values)

public Cursor.Builder addAllValues(Iterable<? extends Value> values)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
values	Iterable<? extends com.google.firestore.v1.Value>

Returns
Type	Description
Cursor.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Cursor.Builder

Overrides

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

addValues(Value value)

public Cursor.Builder addValues(Value value)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
value	Value

Returns
Type	Description
Cursor.Builder

addValues(Value.Builder builderForValue)

public Cursor.Builder addValues(Value.Builder builderForValue)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
builderForValue	Value.Builder

Returns
Type	Description
Cursor.Builder

addValues(int index, Value value)

public Cursor.Builder addValues(int index, Value value)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
Cursor.Builder

addValues(int index, Value.Builder builderForValue)

public Cursor.Builder addValues(int index, Value.Builder builderForValue)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
Cursor.Builder

addValuesBuilder()

public Value.Builder addValuesBuilder()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type	Description
Value.Builder

addValuesBuilder(int index)

public Value.Builder addValuesBuilder(int index)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Value.Builder

build()

public Cursor build()

Returns
Type	Description
Cursor

buildPartial()

public Cursor buildPartial()

Returns
Type	Description
Cursor

clear()

public Cursor.Builder clear()

Returns
Type	Description
Cursor.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBefore()

public Cursor.Builder clearBefore()

If the position is just before or just after the given values, relative to the sort order defined by the query.

bool before = 2;

Returns
Type	Description
Cursor.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Cursor.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Cursor.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public Cursor.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Cursor.Builder

Overrides

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

clearValues()

public Cursor.Builder clearValues()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type	Description
Cursor.Builder

clone()

public Cursor.Builder clone()

Returns
Type	Description
Cursor.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBefore()

public boolean getBefore()

If the position is just before or just after the given values, relative to the sort order defined by the query.

bool before = 2;

Returns
Type	Description
boolean	The before.

getDefaultInstanceForType()

public Cursor getDefaultInstanceForType()

Returns
Type	Description
Cursor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getValues(int index)

public Value getValues(int index)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Value

getValuesBuilder(int index)

public Value.Builder getValuesBuilder(int index)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Value.Builder

getValuesBuilderList()

public List<Value.Builder> getValuesBuilderList()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type	Description
List<Builder>

getValuesCount()

public int getValuesCount()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type	Description
int

getValuesList()

public List<Value> getValuesList()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type	Description
List<Value>

getValuesOrBuilder(int index)

public ValueOrBuilder getValuesOrBuilder(int index)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
ValueOrBuilder

getValuesOrBuilderList()

public List<? extends ValueOrBuilder> getValuesOrBuilderList()

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Returns
Type	Description
List<? extends com.google.firestore.v1.ValueOrBuilder>

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

public Cursor.Builder mergeFrom(Cursor other)

Parameter
Name	Description
other	Cursor

Returns
Type	Description
Cursor.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Cursor.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Cursor.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Cursor.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cursor.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Cursor.Builder

Overrides

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

removeValues(int index)

public Cursor.Builder removeValues(int index)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameter
Name	Description
index	int

Returns
Type	Description
Cursor.Builder

setBefore(boolean value)

public Cursor.Builder setBefore(boolean value)

If the position is just before or just after the given values, relative to the sort order defined by the query.

bool before = 2;

Parameter
Name	Description
value	boolean The before to set.

Returns
Type	Description
Cursor.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Cursor.Builder

Overrides

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

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Cursor.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Cursor.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Cursor.Builder

Overrides

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

setValues(int index, Value value)

public Cursor.Builder setValues(int index, Value value)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
Cursor.Builder

setValues(int index, Value.Builder builderForValue)

public Cursor.Builder setValues(int index, Value.Builder builderForValue)

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

repeated .google.firestore.v1.Value values = 1;

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
Cursor.Builder