Class Cursor.Builder (3.21.3)

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

Implements

CursorOrBuilder

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public Cursor.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Cursor.Builder
Overrides

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

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Cursor.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Cursor.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cursor.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Cursor.Builder
Overrides

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Cursor.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Cursor.Builder
Overrides

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