public interface StructuredQueryOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getEndAt()
public abstract Cursor getEndAt()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Type | Description |
Cursor | The endAt. |
getEndAtOrBuilder()
public abstract CursorOrBuilder getEndAtOrBuilder()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Type | Description |
CursorOrBuilder |
getFrom(int index)
public abstract StructuredQuery.CollectionSelector getFrom(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
Type | Description |
StructuredQuery.CollectionSelector |
getFromCount()
public abstract int getFromCount()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
int |
getFromList()
public abstract List<StructuredQuery.CollectionSelector> getFromList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
List<CollectionSelector> |
getFromOrBuilder(int index)
public abstract StructuredQuery.CollectionSelectorOrBuilder getFromOrBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
Type | Description |
StructuredQuery.CollectionSelectorOrBuilder |
getFromOrBuilderList()
public abstract List<? extends StructuredQuery.CollectionSelectorOrBuilder> getFromOrBuilderList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
List<? extends com.google.firestore.v1.StructuredQuery.CollectionSelectorOrBuilder> |
getLimit()
public abstract Int32Value getLimit()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Type | Description |
Int32Value | The limit. |
getLimitOrBuilder()
public abstract Int32ValueOrBuilder getLimitOrBuilder()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Type | Description |
Int32ValueOrBuilder |
getOffset()
public abstract int getOffset()
The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
int32 offset = 6;
Type | Description |
int | The offset. |
getOrderBy(int index)
public abstract 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 inorder_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
becomesSELECT * FROM Foo ORDER BY A, name
SELECT * FROM Foo ORDER BY A DESC
becomesSELECT * FROM Foo ORDER BY A DESC, name DESC
SELECT * FROM Foo WHERE A > 1
becomesSELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
Name | Description |
index | int |
Type | Description |
StructuredQuery.Order |
getOrderByCount()
public abstract 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 inorder_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
becomesSELECT * FROM Foo ORDER BY A, name
SELECT * FROM Foo ORDER BY A DESC
becomesSELECT * FROM Foo ORDER BY A DESC, name DESC
SELECT * FROM Foo WHERE A > 1
becomesSELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
Type | Description |
int |
getOrderByList()
public abstract 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 inorder_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
becomesSELECT * FROM Foo ORDER BY A, name
SELECT * FROM Foo ORDER BY A DESC
becomesSELECT * FROM Foo ORDER BY A DESC, name DESC
SELECT * FROM Foo WHERE A > 1
becomesSELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
Type | Description |
List<Order> |
getOrderByOrBuilder(int index)
public abstract 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 inorder_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
becomesSELECT * FROM Foo ORDER BY A, name
SELECT * FROM Foo ORDER BY A DESC
becomesSELECT * FROM Foo ORDER BY A DESC, name DESC
SELECT * FROM Foo WHERE A > 1
becomesSELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
Name | Description |
index | int |
Type | Description |
StructuredQuery.OrderOrBuilder |
getOrderByOrBuilderList()
public abstract 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 inorder_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
becomesSELECT * FROM Foo ORDER BY A, name
SELECT * FROM Foo ORDER BY A DESC
becomesSELECT * FROM Foo ORDER BY A DESC, name DESC
SELECT * FROM Foo WHERE A > 1
becomesSELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
Type | Description |
List<? extends com.google.firestore.v1.StructuredQuery.OrderOrBuilder> |
getSelect()
public abstract StructuredQuery.Projection getSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
StructuredQuery.Projection | The select. |
getSelectOrBuilder()
public abstract StructuredQuery.ProjectionOrBuilder getSelectOrBuilder()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
StructuredQuery.ProjectionOrBuilder |
getStartAt()
public abstract Cursor getStartAt()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Type | Description |
Cursor | The startAt. |
getStartAtOrBuilder()
public abstract CursorOrBuilder getStartAtOrBuilder()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Type | Description |
CursorOrBuilder |
getWhere()
public abstract StructuredQuery.Filter getWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
StructuredQuery.Filter | The where. |
getWhereOrBuilder()
public abstract StructuredQuery.FilterOrBuilder getWhereOrBuilder()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
StructuredQuery.FilterOrBuilder |
hasEndAt()
public abstract boolean hasEndAt()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Type | Description |
boolean | Whether the endAt field is set. |
hasLimit()
public abstract boolean hasLimit()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Type | Description |
boolean | Whether the limit field is set. |
hasSelect()
public abstract boolean hasSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
boolean | Whether the select field is set. |
hasStartAt()
public abstract boolean hasStartAt()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Type | Description |
boolean | Whether the startAt field is set. |
hasWhere()
public abstract boolean hasWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
boolean | Whether the where field is set. |