com.google.firestore.v1beta1

Interface StructuredQueryOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

StructuredQuery, StructuredQuery.Builder

public interface StructuredQueryOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Cursor	getEndAt() A end point for the query results.
CursorOrBuilder	getEndAtOrBuilder() A end point for the query results.
StructuredQuery.CollectionSelector	getFrom(int index) The collections to query.
int	getFromCount() The collections to query.
java.util.List<StructuredQuery.CollectionSelector>	getFromList() The collections to query.
StructuredQuery.CollectionSelectorOrBuilder	getFromOrBuilder(int index) The collections to query.
java.util.List<? extends StructuredQuery.CollectionSelectorOrBuilder>	getFromOrBuilderList() The collections to query.
Int32Value	getLimit() The maximum number of results to return.
Int32ValueOrBuilder	getLimitOrBuilder() The maximum number of results to return.
int	getOffset() The number of results to skip.
StructuredQuery.Order	getOrderBy(int index) The order to apply to the query results.
int	getOrderByCount() The order to apply to the query results.
java.util.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.
java.util.List<? extends StructuredQuery.OrderOrBuilder>	getOrderByOrBuilderList() The order to apply to the query results.
StructuredQuery.Projection	getSelect() The projection to return.
StructuredQuery.ProjectionOrBuilder	getSelectOrBuilder() The projection to return.
Cursor	getStartAt() A starting point for the query results.
CursorOrBuilder	getStartAtOrBuilder() A starting point for the query results.
StructuredQuery.Filter	getWhere() The filter to apply.
StructuredQuery.FilterOrBuilder	getWhereOrBuilder() The filter to apply.
boolean	hasEndAt() A end point for the query results.
boolean	hasLimit() The maximum number of results to return.
boolean	hasSelect() The projection to return.
boolean	hasStartAt() A starting point for the query results.
boolean	hasWhere() The filter to apply.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasSelect

boolean hasSelect()

 The projection to return.
 

.google.firestore.v1beta1.StructuredQuery.Projection select = 1;

getSelect

StructuredQuery.Projection getSelect()

 The projection to return.
 

.google.firestore.v1beta1.StructuredQuery.Projection select = 1;

getSelectOrBuilder

StructuredQuery.ProjectionOrBuilder getSelectOrBuilder()

 The projection to return.
 

.google.firestore.v1beta1.StructuredQuery.Projection select = 1;

getFromList

java.util.List<StructuredQuery.CollectionSelector> getFromList()

 The collections to query.
 

repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;

getFrom

StructuredQuery.CollectionSelector getFrom(int index)

 The collections to query.
 

repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;

getFromCount

int getFromCount()

 The collections to query.
 

repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;

getFromOrBuilderList

java.util.List<? extends StructuredQuery.CollectionSelectorOrBuilder> getFromOrBuilderList()

 The collections to query.
 

repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;

getFromOrBuilder

StructuredQuery.CollectionSelectorOrBuilder getFromOrBuilder(int index)

 The collections to query.
 

repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;

hasWhere

boolean hasWhere()

 The filter to apply.
 

.google.firestore.v1beta1.StructuredQuery.Filter where = 3;

getWhere

StructuredQuery.Filter getWhere()

 The filter to apply.
 

.google.firestore.v1beta1.StructuredQuery.Filter where = 3;

getWhereOrBuilder

StructuredQuery.FilterOrBuilder getWhereOrBuilder()

 The filter to apply.
 

.google.firestore.v1beta1.StructuredQuery.Filter where = 3;

getOrderByList

java.util.List<StructuredQuery.Order> getOrderByList()

 The order to apply to the query results.
 Firestore guarantees a stable ordering through the following rules:
  * Any field required to appear in `order_by`, that is not already
    specified in `order_by`, is appended to the order in field name order
    by default.
  * 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:
  * `SELECT * FROM Foo ORDER BY A` becomes
    `SELECT * FROM Foo ORDER BY A, __name__`
  * `SELECT * FROM Foo ORDER BY A DESC` becomes
    `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
  * `SELECT * FROM Foo WHERE A > 1` becomes
    `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
 

repeated .google.firestore.v1beta1.StructuredQuery.Order order_by = 4;

getOrderBy

StructuredQuery.Order getOrderBy(int index)

 The order to apply to the query results.
 Firestore guarantees a stable ordering through the following rules:
  * Any field required to appear in `order_by`, that is not already
    specified in `order_by`, is appended to the order in field name order
    by default.
  * 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:
  * `SELECT * FROM Foo ORDER BY A` becomes
    `SELECT * FROM Foo ORDER BY A, __name__`
  * `SELECT * FROM Foo ORDER BY A DESC` becomes
    `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
  * `SELECT * FROM Foo WHERE A > 1` becomes
    `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
 

repeated .google.firestore.v1beta1.StructuredQuery.Order order_by = 4;

getOrderByCount

int getOrderByCount()

 The order to apply to the query results.
 Firestore guarantees a stable ordering through the following rules:
  * Any field required to appear in `order_by`, that is not already
    specified in `order_by`, is appended to the order in field name order
    by default.
  * 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:
  * `SELECT * FROM Foo ORDER BY A` becomes
    `SELECT * FROM Foo ORDER BY A, __name__`
  * `SELECT * FROM Foo ORDER BY A DESC` becomes
    `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
  * `SELECT * FROM Foo WHERE A > 1` becomes
    `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
 

repeated .google.firestore.v1beta1.StructuredQuery.Order order_by = 4;

getOrderByOrBuilderList

java.util.List<? extends StructuredQuery.OrderOrBuilder> getOrderByOrBuilderList()

 The order to apply to the query results.
 Firestore guarantees a stable ordering through the following rules:
  * Any field required to appear in `order_by`, that is not already
    specified in `order_by`, is appended to the order in field name order
    by default.
  * 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:
  * `SELECT * FROM Foo ORDER BY A` becomes
    `SELECT * FROM Foo ORDER BY A, __name__`
  * `SELECT * FROM Foo ORDER BY A DESC` becomes
    `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
  * `SELECT * FROM Foo WHERE A > 1` becomes
    `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
 

repeated .google.firestore.v1beta1.StructuredQuery.Order order_by = 4;

getOrderByOrBuilder

StructuredQuery.OrderOrBuilder getOrderByOrBuilder(int index)

 The order to apply to the query results.
 Firestore guarantees a stable ordering through the following rules:
  * Any field required to appear in `order_by`, that is not already
    specified in `order_by`, is appended to the order in field name order
    by default.
  * 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:
  * `SELECT * FROM Foo ORDER BY A` becomes
    `SELECT * FROM Foo ORDER BY A, __name__`
  * `SELECT * FROM Foo ORDER BY A DESC` becomes
    `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
  * `SELECT * FROM Foo WHERE A > 1` becomes
    `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
 

repeated .google.firestore.v1beta1.StructuredQuery.Order order_by = 4;

hasStartAt

boolean hasStartAt()

 A starting point for the query results.
 

.google.firestore.v1beta1.Cursor start_at = 7;

getStartAt

Cursor getStartAt()

 A starting point for the query results.
 

.google.firestore.v1beta1.Cursor start_at = 7;

getStartAtOrBuilder

CursorOrBuilder getStartAtOrBuilder()

 A starting point for the query results.
 

.google.firestore.v1beta1.Cursor start_at = 7;

hasEndAt

boolean hasEndAt()

 A end point for the query results.
 

.google.firestore.v1beta1.Cursor end_at = 8;

getEndAt

Cursor getEndAt()

 A end point for the query results.
 

.google.firestore.v1beta1.Cursor end_at = 8;

getEndAtOrBuilder

CursorOrBuilder getEndAtOrBuilder()

 A end point for the query results.
 

.google.firestore.v1beta1.Cursor end_at = 8;

getOffset

int getOffset()

 The number of results to skip.
 Applies before limit, but after all other constraints. Must be >= 0 if
 specified.
 

int32 offset = 6;

hasLimit

boolean hasLimit()

 The maximum number of results to return.
 Applies after all other constraints.
 Must be >= 0 if specified.
 

.google.protobuf.Int32Value limit = 5;

getLimit

Int32Value getLimit()

 The maximum number of results to return.
 Applies after all other constraints.
 Must be >= 0 if specified.
 

.google.protobuf.Int32Value limit = 5;

getLimitOrBuilder

Int32ValueOrBuilder getLimitOrBuilder()

 The maximum number of results to return.
 Applies after all other constraints.
 Must be >= 0 if specified.
 

.google.protobuf.Int32Value limit = 5;