public static final class StructuredQuery.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder> implements StructuredQueryOrBuilder
A Firestore query.Protobuf type
google.firestore.v1.StructuredQuery| Modifier and Type | Method and Description |
|---|---|
StructuredQuery.Builder |
addAllFrom(Iterable<? extends StructuredQuery.CollectionSelector> values)
The collections to query.
|
StructuredQuery.Builder |
addAllOrderBy(Iterable<? extends StructuredQuery.Order> values)
The order to apply to the query results.
|
StructuredQuery.Builder |
addFrom(int index,
StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
|
StructuredQuery.Builder |
addFrom(int index,
StructuredQuery.CollectionSelector value)
The collections to query.
|
StructuredQuery.Builder |
addFrom(StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
|
StructuredQuery.Builder |
addFrom(StructuredQuery.CollectionSelector value)
The collections to query.
|
StructuredQuery.CollectionSelector.Builder |
addFromBuilder()
The collections to query.
|
StructuredQuery.CollectionSelector.Builder |
addFromBuilder(int index)
The collections to query.
|
StructuredQuery.Builder |
addOrderBy(int index,
StructuredQuery.Order.Builder builderForValue)
The order to apply to the query results.
|
StructuredQuery.Builder |
addOrderBy(int index,
StructuredQuery.Order value)
The order to apply to the query results.
|
StructuredQuery.Builder |
addOrderBy(StructuredQuery.Order.Builder builderForValue)
The order to apply to the query results.
|
StructuredQuery.Builder |
addOrderBy(StructuredQuery.Order value)
The order to apply to the query results.
|
StructuredQuery.Order.Builder |
addOrderByBuilder()
The order to apply to the query results.
|
StructuredQuery.Order.Builder |
addOrderByBuilder(int index)
The order to apply to the query results.
|
StructuredQuery.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
StructuredQuery |
build() |
StructuredQuery |
buildPartial() |
StructuredQuery.Builder |
clear() |
StructuredQuery.Builder |
clearEndAt()
A potential prefix of a position in the result set to end the query at.
|
StructuredQuery.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
StructuredQuery.Builder |
clearFrom()
The collections to query.
|
StructuredQuery.Builder |
clearLimit()
The maximum number of results to return.
|
StructuredQuery.Builder |
clearOffset()
The number of documents to skip before returning the first result.
|
StructuredQuery.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
StructuredQuery.Builder |
clearOrderBy()
The order to apply to the query results.
|
StructuredQuery.Builder |
clearSelect()
Optional sub-set of the fields to return.
|
StructuredQuery.Builder |
clearStartAt()
A potential prefix of a position in the result set to start the query at.
|
StructuredQuery.Builder |
clearWhere()
The filter to apply.
|
StructuredQuery.Builder |
clone() |
StructuredQuery |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Cursor |
getEndAt()
A potential prefix of a position in the result set to end the query at.
|
Cursor.Builder |
getEndAtBuilder()
A potential prefix of a position in the result set to end the query at.
|
CursorOrBuilder |
getEndAtOrBuilder()
A potential prefix of a position in the result set to end the query at.
|
StructuredQuery.CollectionSelector |
getFrom(int index)
The collections to query.
|
StructuredQuery.CollectionSelector.Builder |
getFromBuilder(int index)
The collections to query.
|
List<StructuredQuery.CollectionSelector.Builder> |
getFromBuilderList()
The collections to query.
|
int |
getFromCount()
The collections to query.
|
List<StructuredQuery.CollectionSelector> |
getFromList()
The collections to query.
|
StructuredQuery.CollectionSelectorOrBuilder |
getFromOrBuilder(int index)
The collections to query.
|
List<? extends StructuredQuery.CollectionSelectorOrBuilder> |
getFromOrBuilderList()
The collections to query.
|
com.google.protobuf.Int32Value |
getLimit()
The maximum number of results to return.
|
com.google.protobuf.Int32Value.Builder |
getLimitBuilder()
The maximum number of results to return.
|
com.google.protobuf.Int32ValueOrBuilder |
getLimitOrBuilder()
The maximum number of results to return.
|
int |
getOffset()
The number of documents to skip before returning the first result.
|
StructuredQuery.Order |
getOrderBy(int index)
The order to apply to the query results.
|
StructuredQuery.Order.Builder |
getOrderByBuilder(int index)
The order to apply to the query results.
|
List<StructuredQuery.Order.Builder> |
getOrderByBuilderList()
The order to apply to the query results.
|
int |
getOrderByCount()
The order to apply to the query results.
|
List<StructuredQuery.Order> |
getOrderByList()
The order to apply to the query results.
|
StructuredQuery.OrderOrBuilder |
getOrderByOrBuilder(int index)
The order to apply to the query results.
|
List<? extends StructuredQuery.OrderOrBuilder> |
getOrderByOrBuilderList()
The order to apply to the query results.
|
StructuredQuery.Projection |
getSelect()
Optional sub-set of the fields to return.
|
StructuredQuery.Projection.Builder |
getSelectBuilder()
Optional sub-set of the fields to return.
|
StructuredQuery.ProjectionOrBuilder |
getSelectOrBuilder()
Optional sub-set of the fields to return.
|
Cursor |
getStartAt()
A potential prefix of a position in the result set to start the query at.
|
Cursor.Builder |
getStartAtBuilder()
A potential prefix of a position in the result set to start the query at.
|
CursorOrBuilder |
getStartAtOrBuilder()
A potential prefix of a position in the result set to start the query at.
|
StructuredQuery.Filter |
getWhere()
The filter to apply.
|
StructuredQuery.Filter.Builder |
getWhereBuilder()
The filter to apply.
|
StructuredQuery.FilterOrBuilder |
getWhereOrBuilder()
The filter to apply.
|
boolean |
hasEndAt()
A potential prefix of a position in the result set to end the query at.
|
boolean |
hasLimit()
The maximum number of results to return.
|
boolean |
hasSelect()
Optional sub-set of the fields to return.
|
boolean |
hasStartAt()
A potential prefix of a position in the result set to start the query at.
|
boolean |
hasWhere()
The filter to apply.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
StructuredQuery.Builder |
mergeEndAt(Cursor value)
A potential prefix of a position in the result set to end the query at.
|
StructuredQuery.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
StructuredQuery.Builder |
mergeFrom(com.google.protobuf.Message other) |
StructuredQuery.Builder |
mergeFrom(StructuredQuery other) |
StructuredQuery.Builder |
mergeLimit(com.google.protobuf.Int32Value value)
The maximum number of results to return.
|
StructuredQuery.Builder |
mergeSelect(StructuredQuery.Projection value)
Optional sub-set of the fields to return.
|
StructuredQuery.Builder |
mergeStartAt(Cursor value)
A potential prefix of a position in the result set to start the query at.
|
StructuredQuery.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
StructuredQuery.Builder |
mergeWhere(StructuredQuery.Filter value)
The filter to apply.
|
StructuredQuery.Builder |
removeFrom(int index)
The collections to query.
|
StructuredQuery.Builder |
removeOrderBy(int index)
The order to apply to the query results.
|
StructuredQuery.Builder |
setEndAt(Cursor.Builder builderForValue)
A potential prefix of a position in the result set to end the query at.
|
StructuredQuery.Builder |
setEndAt(Cursor value)
A potential prefix of a position in the result set to end the query at.
|
StructuredQuery.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
StructuredQuery.Builder |
setFrom(int index,
StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
|
StructuredQuery.Builder |
setFrom(int index,
StructuredQuery.CollectionSelector value)
The collections to query.
|
StructuredQuery.Builder |
setLimit(com.google.protobuf.Int32Value.Builder builderForValue)
The maximum number of results to return.
|
StructuredQuery.Builder |
setLimit(com.google.protobuf.Int32Value value)
The maximum number of results to return.
|
StructuredQuery.Builder |
setOffset(int value)
The number of documents to skip before returning the first result.
|
StructuredQuery.Builder |
setOrderBy(int index,
StructuredQuery.Order.Builder builderForValue)
The order to apply to the query results.
|
StructuredQuery.Builder |
setOrderBy(int index,
StructuredQuery.Order value)
The order to apply to the query results.
|
StructuredQuery.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
StructuredQuery.Builder |
setSelect(StructuredQuery.Projection.Builder builderForValue)
Optional sub-set of the fields to return.
|
StructuredQuery.Builder |
setSelect(StructuredQuery.Projection value)
Optional sub-set of the fields to return.
|
StructuredQuery.Builder |
setStartAt(Cursor.Builder builderForValue)
A potential prefix of a position in the result set to start the query at.
|
StructuredQuery.Builder |
setStartAt(Cursor value)
A potential prefix of a position in the result set to start the query at.
|
StructuredQuery.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
StructuredQuery.Builder |
setWhere(StructuredQuery.Filter.Builder builderForValue)
The filter to apply.
|
StructuredQuery.Builder |
setWhere(StructuredQuery.Filter value)
The filter to apply.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic StructuredQuery build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic StructuredQuery buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic StructuredQuery.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredQuery.Builder>public StructuredQuery.Builder mergeFrom(StructuredQuery other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public StructuredQuery.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<StructuredQuery.Builder>IOExceptionpublic boolean hasSelect()
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;hasSelect in interface StructuredQueryOrBuilderpublic StructuredQuery.Projection getSelect()
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;getSelect in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setSelect(StructuredQuery.Projection value)
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;public StructuredQuery.Builder setSelect(StructuredQuery.Projection.Builder builderForValue)
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;public StructuredQuery.Builder mergeSelect(StructuredQuery.Projection value)
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;public StructuredQuery.Builder clearSelect()
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;public StructuredQuery.Projection.Builder getSelectBuilder()
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;public StructuredQuery.ProjectionOrBuilder getSelectOrBuilder()
Optional sub-set of the fields to return. This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
.google.firestore.v1.StructuredQuery.Projection select = 1;getSelectOrBuilder in interface StructuredQueryOrBuilderpublic List<StructuredQuery.CollectionSelector> getFromList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromList in interface StructuredQueryOrBuilderpublic int getFromCount()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromCount in interface StructuredQueryOrBuilderpublic StructuredQuery.CollectionSelector getFrom(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFrom in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setFrom(int index, StructuredQuery.CollectionSelector value)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder setFrom(int index, StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder addFrom(StructuredQuery.CollectionSelector value)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder addFrom(int index, StructuredQuery.CollectionSelector value)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder addFrom(StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder addFrom(int index, StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder addAllFrom(Iterable<? extends StructuredQuery.CollectionSelector> values)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder clearFrom()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.Builder removeFrom(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.CollectionSelector.Builder getFromBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.CollectionSelectorOrBuilder getFromOrBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromOrBuilder in interface StructuredQueryOrBuilderpublic List<? extends StructuredQuery.CollectionSelectorOrBuilder> getFromOrBuilderList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromOrBuilderList in interface StructuredQueryOrBuilderpublic StructuredQuery.CollectionSelector.Builder addFromBuilder()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public StructuredQuery.CollectionSelector.Builder addFromBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public List<StructuredQuery.CollectionSelector.Builder> getFromBuilderList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;public boolean hasWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;hasWhere in interface StructuredQueryOrBuilderpublic StructuredQuery.Filter getWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;getWhere in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setWhere(StructuredQuery.Filter value)
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;public StructuredQuery.Builder setWhere(StructuredQuery.Filter.Builder builderForValue)
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;public StructuredQuery.Builder mergeWhere(StructuredQuery.Filter value)
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;public StructuredQuery.Builder clearWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;public StructuredQuery.Filter.Builder getWhereBuilder()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;public StructuredQuery.FilterOrBuilder getWhereOrBuilder()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;getWhereOrBuilder in interface StructuredQueryOrBuilderpublic List<StructuredQuery.Order> getOrderByList()
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;getOrderByList in interface StructuredQueryOrBuilderpublic int getOrderByCount()
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;getOrderByCount in interface StructuredQueryOrBuilderpublic StructuredQuery.Order getOrderBy(int index)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;getOrderBy in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setOrderBy(int index, StructuredQuery.Order value)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder setOrderBy(int index, StructuredQuery.Order.Builder builderForValue)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder addOrderBy(StructuredQuery.Order value)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder addOrderBy(int index, StructuredQuery.Order value)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder addOrderBy(StructuredQuery.Order.Builder builderForValue)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder addOrderBy(int index, StructuredQuery.Order.Builder builderForValue)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder addAllOrderBy(Iterable<? extends StructuredQuery.Order> values)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder clearOrderBy()
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Builder removeOrderBy(int index)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Order.Builder getOrderByBuilder(int index)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.OrderOrBuilder getOrderByOrBuilder(int index)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;getOrderByOrBuilder in interface StructuredQueryOrBuilderpublic List<? extends StructuredQuery.OrderOrBuilder> getOrderByOrBuilderList()
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;getOrderByOrBuilderList in interface StructuredQueryOrBuilderpublic StructuredQuery.Order.Builder addOrderByBuilder()
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public StructuredQuery.Order.Builder addOrderByBuilder(int index)
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public List<StructuredQuery.Order.Builder> getOrderByBuilderList()
The order to apply to the query results.
Firestore allows callers to provide a full ordering, a partial ordering, or
no ordering at all. In all cases, Firestore guarantees a stable ordering
through the following rules:
* The `order_by` is required to reference all fields used with an
inequality filter.
* All fields that are required to be in the `order_by` but are not already
present are appended in lexicographical ordering of the field name.
* If an order on `__name__` is not specified, it is appended by default.
Fields are appended with the same sort direction as the last order
specified, or 'ASCENDING' if no order was specified. For example:
* `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
* `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
* `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
* `WHERE __name__ > ... AND a > 1` becomes
`WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;public boolean hasStartAt()
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;hasStartAt in interface StructuredQueryOrBuilderpublic Cursor getStartAt()
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;getStartAt in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setStartAt(Cursor value)
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;public StructuredQuery.Builder setStartAt(Cursor.Builder builderForValue)
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;public StructuredQuery.Builder mergeStartAt(Cursor value)
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;public StructuredQuery.Builder clearStartAt()
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;public Cursor.Builder getStartAtBuilder()
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;public CursorOrBuilder getStartAtOrBuilder()
A potential prefix of a position in the result set to start the query at.
The ordering of the result set is based on the `ORDER BY` clause of the
original query.
```
SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
```
This query's results are ordered by `(b ASC, __name__ ASC)`.
Cursors can reference either the full ordering or a prefix of the location,
though it cannot reference more fields than what are in the provided
`ORDER BY`.
Continuing off the example above, attaching the following start cursors
will have varying impact:
- `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
b > 2 AND __name__ > /k/123`.
- `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
Unlike `OFFSET` which requires scanning over the first N results to skip,
a start cursor allows the query to begin at a logical position. This
position is not required to match an actual result, it will scan forward
from this position to find the next document.
Requires:
* The number of values cannot be greater than the number of fields
specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor start_at = 7;getStartAtOrBuilder in interface StructuredQueryOrBuilderpublic boolean hasEndAt()
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;hasEndAt in interface StructuredQueryOrBuilderpublic Cursor getEndAt()
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;getEndAt in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setEndAt(Cursor value)
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;public StructuredQuery.Builder setEndAt(Cursor.Builder builderForValue)
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;public StructuredQuery.Builder mergeEndAt(Cursor value)
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;public StructuredQuery.Builder clearEndAt()
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;public Cursor.Builder getEndAtBuilder()
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;public CursorOrBuilder getEndAtOrBuilder()
A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause.
.google.firestore.v1.Cursor end_at = 8;getEndAtOrBuilder in interface StructuredQueryOrBuilderpublic int getOffset()
The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified.
int32 offset = 6;getOffset in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setOffset(int value)
The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified.
int32 offset = 6;value - The offset to set.public StructuredQuery.Builder clearOffset()
The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified.
int32 offset = 6;public boolean hasLimit()
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;hasLimit in interface StructuredQueryOrBuilderpublic com.google.protobuf.Int32Value getLimit()
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;getLimit in interface StructuredQueryOrBuilderpublic StructuredQuery.Builder setLimit(com.google.protobuf.Int32Value value)
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;public StructuredQuery.Builder setLimit(com.google.protobuf.Int32Value.Builder builderForValue)
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;public StructuredQuery.Builder mergeLimit(com.google.protobuf.Int32Value value)
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;public StructuredQuery.Builder clearLimit()
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;public com.google.protobuf.Int32Value.Builder getLimitBuilder()
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;public com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()
The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.
.google.protobuf.Int32Value limit = 5;getLimitOrBuilder in interface StructuredQueryOrBuilderpublic final StructuredQuery.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>public final StructuredQuery.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StructuredQuery.Builder>Copyright © 2023 Google LLC. All rights reserved.