Class Cursor.Builder (3.17.0)

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
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.firestore.v1.Value>
Returns
TypeDescription
Cursor.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Cursor.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueValue
Returns
TypeDescription
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
NameDescription
builderForValueValue.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueValue
Returns
TypeDescription
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
NameDescription
indexint
builderForValueValue.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Value.Builder

build()

public Cursor build()
Returns
TypeDescription
Cursor

buildPartial()

public Cursor buildPartial()
Returns
TypeDescription
Cursor

clear()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

public Cursor.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
Cursor.Builder

clone()

public Cursor.Builder clone()
Returns
TypeDescription
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
TypeDescription
boolean

The before.

getDefaultInstanceForType()

public Cursor getDefaultInstanceForType()
Returns
TypeDescription
Cursor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.firestore.v1.ValueOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Cursor other)

public Cursor.Builder mergeFrom(Cursor other)
Parameter
NameDescription
otherCursor
Returns
TypeDescription
Cursor.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cursor.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueboolean

The before to set.

Returns
TypeDescription
Cursor.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Cursor.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
indexint
valueValue
Returns
TypeDescription
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
NameDescription
indexint
builderForValueValue.Builder
Returns
TypeDescription
Cursor.Builder