public final class StructuredQuery extends GeneratedMessageV3 implements StructuredQueryOrBuilder
A Firestore query.
Protobuf type google.firestore.v1.StructuredQuery
Static Fields
END_AT_FIELD_NUMBER
public static final int END_AT_FIELD_NUMBER
Field Value
FROM_FIELD_NUMBER
public static final int FROM_FIELD_NUMBER
Field Value
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
Field Value
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
SELECT_FIELD_NUMBER
public static final int SELECT_FIELD_NUMBER
Field Value
START_AT_FIELD_NUMBER
public static final int START_AT_FIELD_NUMBER
Field Value
WHERE_FIELD_NUMBER
public static final int WHERE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static StructuredQuery getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static StructuredQuery.Builder newBuilder()
Returns
newBuilder(StructuredQuery prototype)
public static StructuredQuery.Builder newBuilder(StructuredQuery prototype)
Parameter
Returns
public static StructuredQuery parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static StructuredQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static StructuredQuery parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static StructuredQuery parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StructuredQuery parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static StructuredQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static StructuredQuery parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static StructuredQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static StructuredQuery parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<StructuredQuery> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public StructuredQuery getDefaultInstanceForType()
Returns
getEndAt()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
| Type | Description |
| Cursor | The endAt.
|
getEndAtOrBuilder()
public CursorOrBuilder getEndAtOrBuilder()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;
getFrom(int index)
public StructuredQuery.CollectionSelector getFrom(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
getFromCount()
public int getFromCount()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
getFromList()
public List<StructuredQuery.CollectionSelector> getFromList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
getFromOrBuilder(int index)
public StructuredQuery.CollectionSelectorOrBuilder getFromOrBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;
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;
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;
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 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, nameSELECT * FROM Foo ORDER BY A DESC becomes
SELECT * FROM Foo ORDER BY A DESC, name DESCSELECT * FROM Foo WHERE A > 1 becomes
SELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
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 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, nameSELECT * FROM Foo ORDER BY A DESC becomes
SELECT * FROM Foo ORDER BY A DESC, name DESCSELECT * FROM Foo WHERE A > 1 becomes
SELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
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 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, nameSELECT * FROM Foo ORDER BY A DESC becomes
SELECT * FROM Foo ORDER BY A DESC, name DESCSELECT * FROM Foo WHERE A > 1 becomes
SELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
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 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, nameSELECT * FROM Foo ORDER BY A DESC becomes
SELECT * FROM Foo ORDER BY A DESC, name DESCSELECT * FROM Foo WHERE A > 1 becomes
SELECT * FROM Foo WHERE A > 1 ORDER BY A, name
repeated .google.firestore.v1.StructuredQuery.Order order_by = 4;
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 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, nameSELECT * FROM Foo ORDER BY A DESC becomes
SELECT * FROM Foo ORDER BY A DESC, name DESCSELECT * FROM Foo WHERE A > 1 becomes
SELECT * 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> | |
getParserForType()
public Parser<StructuredQuery> getParserForType()
Returns
Overrides
getSelect()
public StructuredQuery.Projection getSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
getSelectOrBuilder()
public StructuredQuery.ProjectionOrBuilder getSelectOrBuilder()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getStartAt()
public Cursor getStartAt()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
| Type | Description |
| Cursor | The startAt.
|
getStartAtOrBuilder()
public CursorOrBuilder getStartAtOrBuilder()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getWhere()
public StructuredQuery.Filter getWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
getWhereOrBuilder()
public StructuredQuery.FilterOrBuilder getWhereOrBuilder()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public StructuredQuery.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public StructuredQuery.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
