public static final class StructuredQuery.Builder extends GeneratedMessageV3.Builder<StructuredQuery.Builder> implements StructuredQueryOrBuilder
A Firestore query.
Protobuf type google.firestore.v1.StructuredQuery
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StructuredQuery.BuilderImplements
StructuredQueryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllFrom(Iterable<? extends StructuredQuery.CollectionSelector> values)
public StructuredQuery.Builder addAllFrom(Iterable<? extends StructuredQuery.CollectionSelector> values)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
values | Iterable<? extends com.google.firestore.v1.StructuredQuery.CollectionSelector> |
Type | Description |
StructuredQuery.Builder |
addAllOrderBy(Iterable<? extends StructuredQuery.Order> values)
public StructuredQuery.Builder addAllOrderBy(Iterable<? extends StructuredQuery.Order> values)
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 |
values | Iterable<? extends com.google.firestore.v1.StructuredQuery.Order> |
Type | Description |
StructuredQuery.Builder |
addFrom(StructuredQuery.CollectionSelector value)
public StructuredQuery.Builder addFrom(StructuredQuery.CollectionSelector value)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
value | StructuredQuery.CollectionSelector |
Type | Description |
StructuredQuery.Builder |
addFrom(StructuredQuery.CollectionSelector.Builder builderForValue)
public StructuredQuery.Builder addFrom(StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
builderForValue | StructuredQuery.CollectionSelector.Builder |
Type | Description |
StructuredQuery.Builder |
addFrom(int index, StructuredQuery.CollectionSelector value)
public StructuredQuery.Builder addFrom(int index, StructuredQuery.CollectionSelector value)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
value | StructuredQuery.CollectionSelector |
Type | Description |
StructuredQuery.Builder |
addFrom(int index, StructuredQuery.CollectionSelector.Builder builderForValue)
public StructuredQuery.Builder addFrom(int index, StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
builderForValue | StructuredQuery.CollectionSelector.Builder |
Type | Description |
StructuredQuery.Builder |
addFromBuilder()
public StructuredQuery.CollectionSelector.Builder addFromBuilder()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
StructuredQuery.CollectionSelector.Builder |
addFromBuilder(int index)
public StructuredQuery.CollectionSelector.Builder addFromBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
Type | Description |
StructuredQuery.CollectionSelector.Builder |
addOrderBy(StructuredQuery.Order value)
public StructuredQuery.Builder addOrderBy(StructuredQuery.Order value)
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 |
value | StructuredQuery.Order |
Type | Description |
StructuredQuery.Builder |
addOrderBy(StructuredQuery.Order.Builder builderForValue)
public StructuredQuery.Builder addOrderBy(StructuredQuery.Order.Builder builderForValue)
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 |
builderForValue | StructuredQuery.Order.Builder |
Type | Description |
StructuredQuery.Builder |
addOrderBy(int index, StructuredQuery.Order value)
public StructuredQuery.Builder addOrderBy(int index, StructuredQuery.Order value)
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 |
value | StructuredQuery.Order |
Type | Description |
StructuredQuery.Builder |
addOrderBy(int index, StructuredQuery.Order.Builder builderForValue)
public StructuredQuery.Builder addOrderBy(int index, StructuredQuery.Order.Builder builderForValue)
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 |
builderForValue | StructuredQuery.Order.Builder |
Type | Description |
StructuredQuery.Builder |
addOrderByBuilder()
public StructuredQuery.Order.Builder addOrderByBuilder()
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 |
StructuredQuery.Order.Builder |
addOrderByBuilder(int index)
public StructuredQuery.Order.Builder addOrderByBuilder(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.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StructuredQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
StructuredQuery.Builder |
build()
public StructuredQuery build()
Type | Description |
StructuredQuery |
buildPartial()
public StructuredQuery buildPartial()
Type | Description |
StructuredQuery |
clear()
public StructuredQuery.Builder clear()
Type | Description |
StructuredQuery.Builder |
clearEndAt()
public StructuredQuery.Builder clearEndAt()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Type | Description |
StructuredQuery.Builder |
clearField(Descriptors.FieldDescriptor field)
public StructuredQuery.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
StructuredQuery.Builder |
clearFrom()
public StructuredQuery.Builder clearFrom()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
StructuredQuery.Builder |
clearLimit()
public StructuredQuery.Builder clearLimit()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Type | Description |
StructuredQuery.Builder |
clearOffset()
public StructuredQuery.Builder clearOffset()
The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
int32 offset = 6;
Type | Description |
StructuredQuery.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public StructuredQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
StructuredQuery.Builder |
clearOrderBy()
public StructuredQuery.Builder clearOrderBy()
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 |
StructuredQuery.Builder |
clearSelect()
public StructuredQuery.Builder clearSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
StructuredQuery.Builder |
clearStartAt()
public StructuredQuery.Builder clearStartAt()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Type | Description |
StructuredQuery.Builder |
clearWhere()
public StructuredQuery.Builder clearWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
StructuredQuery.Builder |
clone()
public StructuredQuery.Builder clone()
Type | Description |
StructuredQuery.Builder |
getDefaultInstanceForType()
public StructuredQuery getDefaultInstanceForType()
Type | Description |
StructuredQuery |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getEndAt()
public Cursor getEndAt()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Type | Description |
Cursor | The endAt. |
getEndAtBuilder()
public Cursor.Builder getEndAtBuilder()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Type | Description |
Cursor.Builder |
getEndAtOrBuilder()
public CursorOrBuilder getEndAtOrBuilder()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Type | Description |
CursorOrBuilder |
getFrom(int index)
public 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 |
getFromBuilder(int index)
public StructuredQuery.CollectionSelector.Builder getFromBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
Type | Description |
StructuredQuery.CollectionSelector.Builder |
getFromBuilderList()
public List<StructuredQuery.CollectionSelector.Builder> getFromBuilderList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
List<Builder> |
getFromCount()
public int getFromCount()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
int |
getFromList()
public List<StructuredQuery.CollectionSelector> getFromList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Type | Description |
List<CollectionSelector> |
getFromOrBuilder(int index)
public 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 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 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. |
getLimitBuilder()
public Int32Value.Builder getLimitBuilder()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Type | Description |
Builder |
getLimitOrBuilder()
public 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 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 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 |
getOrderByBuilder(int index)
public StructuredQuery.Order.Builder getOrderByBuilder(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.Builder |
getOrderByBuilderList()
public List<StructuredQuery.Order.Builder> getOrderByBuilderList()
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<Builder> |
getOrderByCount()
public 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 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 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 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 StructuredQuery.Projection getSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
StructuredQuery.Projection | The select. |
getSelectBuilder()
public StructuredQuery.Projection.Builder getSelectBuilder()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
StructuredQuery.Projection.Builder |
getSelectOrBuilder()
public StructuredQuery.ProjectionOrBuilder getSelectOrBuilder()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
StructuredQuery.ProjectionOrBuilder |
getStartAt()
public Cursor getStartAt()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Type | Description |
Cursor | The startAt. |
getStartAtBuilder()
public Cursor.Builder getStartAtBuilder()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Type | Description |
Cursor.Builder |
getStartAtOrBuilder()
public CursorOrBuilder getStartAtOrBuilder()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Type | Description |
CursorOrBuilder |
getWhere()
public StructuredQuery.Filter getWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
StructuredQuery.Filter | The where. |
getWhereBuilder()
public StructuredQuery.Filter.Builder getWhereBuilder()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
StructuredQuery.Filter.Builder |
getWhereOrBuilder()
public StructuredQuery.FilterOrBuilder getWhereOrBuilder()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
StructuredQuery.FilterOrBuilder |
hasEndAt()
public 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 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 boolean hasSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Type | Description |
boolean | Whether the select field is set. |
hasStartAt()
public 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 boolean hasWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Type | Description |
boolean | Whether the where field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeEndAt(Cursor value)
public StructuredQuery.Builder mergeEndAt(Cursor value)
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Name | Description |
value | Cursor |
Type | Description |
StructuredQuery.Builder |
mergeFrom(StructuredQuery other)
public StructuredQuery.Builder mergeFrom(StructuredQuery other)
Name | Description |
other | StructuredQuery |
Type | Description |
StructuredQuery.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StructuredQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
StructuredQuery.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public StructuredQuery.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
StructuredQuery.Builder |
mergeLimit(Int32Value value)
public StructuredQuery.Builder mergeLimit(Int32Value value)
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Name | Description |
value | Int32Value |
Type | Description |
StructuredQuery.Builder |
mergeSelect(StructuredQuery.Projection value)
public StructuredQuery.Builder mergeSelect(StructuredQuery.Projection value)
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Name | Description |
value | StructuredQuery.Projection |
Type | Description |
StructuredQuery.Builder |
mergeStartAt(Cursor value)
public StructuredQuery.Builder mergeStartAt(Cursor value)
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Name | Description |
value | Cursor |
Type | Description |
StructuredQuery.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StructuredQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
StructuredQuery.Builder |
mergeWhere(StructuredQuery.Filter value)
public StructuredQuery.Builder mergeWhere(StructuredQuery.Filter value)
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Name | Description |
value | StructuredQuery.Filter |
Type | Description |
StructuredQuery.Builder |
removeFrom(int index)
public StructuredQuery.Builder removeFrom(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
Type | Description |
StructuredQuery.Builder |
removeOrderBy(int index)
public StructuredQuery.Builder removeOrderBy(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.Builder |
setEndAt(Cursor value)
public StructuredQuery.Builder setEndAt(Cursor value)
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Name | Description |
value | Cursor |
Type | Description |
StructuredQuery.Builder |
setEndAt(Cursor.Builder builderForValue)
public StructuredQuery.Builder setEndAt(Cursor.Builder builderForValue)
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
Name | Description |
builderForValue | Cursor.Builder |
Type | Description |
StructuredQuery.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public StructuredQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
StructuredQuery.Builder |
setFrom(int index, StructuredQuery.CollectionSelector value)
public StructuredQuery.Builder setFrom(int index, StructuredQuery.CollectionSelector value)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
value | StructuredQuery.CollectionSelector |
Type | Description |
StructuredQuery.Builder |
setFrom(int index, StructuredQuery.CollectionSelector.Builder builderForValue)
public StructuredQuery.Builder setFrom(int index, StructuredQuery.CollectionSelector.Builder builderForValue)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
Name | Description |
index | int |
builderForValue | StructuredQuery.CollectionSelector.Builder |
Type | Description |
StructuredQuery.Builder |
setLimit(Int32Value value)
public StructuredQuery.Builder setLimit(Int32Value value)
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Name | Description |
value | Int32Value |
Type | Description |
StructuredQuery.Builder |
setLimit(Int32Value.Builder builderForValue)
public StructuredQuery.Builder setLimit(Int32Value.Builder builderForValue)
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;
Name | Description |
builderForValue | Builder |
Type | Description |
StructuredQuery.Builder |
setOffset(int value)
public StructuredQuery.Builder setOffset(int value)
The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
int32 offset = 6;
Name | Description |
value | int The offset to set. |
Type | Description |
StructuredQuery.Builder | This builder for chaining. |
setOrderBy(int index, StructuredQuery.Order value)
public StructuredQuery.Builder setOrderBy(int index, StructuredQuery.Order value)
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 |
value | StructuredQuery.Order |
Type | Description |
StructuredQuery.Builder |
setOrderBy(int index, StructuredQuery.Order.Builder builderForValue)
public StructuredQuery.Builder setOrderBy(int index, StructuredQuery.Order.Builder builderForValue)
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 |
builderForValue | StructuredQuery.Order.Builder |
Type | Description |
StructuredQuery.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StructuredQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
StructuredQuery.Builder |
setSelect(StructuredQuery.Projection value)
public StructuredQuery.Builder setSelect(StructuredQuery.Projection value)
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Name | Description |
value | StructuredQuery.Projection |
Type | Description |
StructuredQuery.Builder |
setSelect(StructuredQuery.Projection.Builder builderForValue)
public StructuredQuery.Builder setSelect(StructuredQuery.Projection.Builder builderForValue)
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
Name | Description |
builderForValue | StructuredQuery.Projection.Builder |
Type | Description |
StructuredQuery.Builder |
setStartAt(Cursor value)
public StructuredQuery.Builder setStartAt(Cursor value)
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Name | Description |
value | Cursor |
Type | Description |
StructuredQuery.Builder |
setStartAt(Cursor.Builder builderForValue)
public StructuredQuery.Builder setStartAt(Cursor.Builder builderForValue)
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
Name | Description |
builderForValue | Cursor.Builder |
Type | Description |
StructuredQuery.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final StructuredQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
StructuredQuery.Builder |
setWhere(StructuredQuery.Filter value)
public StructuredQuery.Builder setWhere(StructuredQuery.Filter value)
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Name | Description |
value | StructuredQuery.Filter |
Type | Description |
StructuredQuery.Builder |
setWhere(StructuredQuery.Filter.Builder builderForValue)
public StructuredQuery.Builder setWhere(StructuredQuery.Filter.Builder builderForValue)
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
Name | Description |
builderForValue | StructuredQuery.Filter.Builder |
Type | Description |
StructuredQuery.Builder |