public final class StructuredQuery extends GeneratedMessageV3 implements StructuredQueryOrBuilder
A Firestore query.Protobuf type
google.firestore.v1beta1.StructuredQuery| Modifier and Type | Class and Description |
|---|---|
static class |
StructuredQuery.Builder
A Firestore query.
|
static class |
StructuredQuery.CollectionSelector
A selection of a collection, such as `messages as m1`.
|
static interface |
StructuredQuery.CollectionSelectorOrBuilder |
static class |
StructuredQuery.CompositeFilter
A filter that merges multiple other filters using the given operator.
|
static interface |
StructuredQuery.CompositeFilterOrBuilder |
static class |
StructuredQuery.Direction
A sort direction.
|
static class |
StructuredQuery.FieldFilter
A filter on a specific field.
|
static interface |
StructuredQuery.FieldFilterOrBuilder |
static class |
StructuredQuery.FieldReference
A reference to a field, such as `max(messages.time) as max_time`.
|
static interface |
StructuredQuery.FieldReferenceOrBuilder |
static class |
StructuredQuery.Filter
A filter.
|
static interface |
StructuredQuery.FilterOrBuilder |
static class |
StructuredQuery.Order
An order on a field.
|
static interface |
StructuredQuery.OrderOrBuilder |
static class |
StructuredQuery.Projection
The projection of document's fields to return.
|
static interface |
StructuredQuery.ProjectionOrBuilder |
static class |
StructuredQuery.UnaryFilter
A filter with a single operand.
|
static interface |
StructuredQuery.UnaryFilterOrBuilder |
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable| Modifier and Type | Field and Description |
|---|---|
static int |
END_AT_FIELD_NUMBER |
static int |
FROM_FIELD_NUMBER |
static int |
LIMIT_FIELD_NUMBER |
static int |
OFFSET_FIELD_NUMBER |
static int |
ORDER_BY_FIELD_NUMBER |
static int |
SELECT_FIELD_NUMBER |
static int |
START_AT_FIELD_NUMBER |
static int |
WHERE_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int SELECT_FIELD_NUMBER
public static final int FROM_FIELD_NUMBER
public static final int WHERE_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
public static final int START_AT_FIELD_NUMBER
public static final int END_AT_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public boolean hasSelect()
The projection to return.
.google.firestore.v1beta1.StructuredQuery.Projection select = 1;hasSelect in interface StructuredQueryOrBuilderpublic StructuredQuery.Projection getSelect()
The projection to return.
.google.firestore.v1beta1.StructuredQuery.Projection select = 1;getSelect in interface StructuredQueryOrBuilderpublic StructuredQuery.ProjectionOrBuilder getSelectOrBuilder()
The projection to return.
.google.firestore.v1beta1.StructuredQuery.Projection select = 1;getSelectOrBuilder in interface StructuredQueryOrBuilderpublic java.util.List<StructuredQuery.CollectionSelector> getFromList()
The collections to query.
repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;getFromList in interface StructuredQueryOrBuilderpublic java.util.List<? extends StructuredQuery.CollectionSelectorOrBuilder> getFromOrBuilderList()
The collections to query.
repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;getFromOrBuilderList in interface StructuredQueryOrBuilderpublic int getFromCount()
The collections to query.
repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;getFromCount in interface StructuredQueryOrBuilderpublic StructuredQuery.CollectionSelector getFrom(int index)
The collections to query.
repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;getFrom in interface StructuredQueryOrBuilderpublic StructuredQuery.CollectionSelectorOrBuilder getFromOrBuilder(int index)
The collections to query.
repeated .google.firestore.v1beta1.StructuredQuery.CollectionSelector from = 2;getFromOrBuilder in interface StructuredQueryOrBuilderpublic boolean hasWhere()
The filter to apply.
.google.firestore.v1beta1.StructuredQuery.Filter where = 3;hasWhere in interface StructuredQueryOrBuilderpublic StructuredQuery.Filter getWhere()
The filter to apply.
.google.firestore.v1beta1.StructuredQuery.Filter where = 3;getWhere in interface StructuredQueryOrBuilderpublic StructuredQuery.FilterOrBuilder getWhereOrBuilder()
The filter to apply.
.google.firestore.v1beta1.StructuredQuery.Filter where = 3;getWhereOrBuilder in interface StructuredQueryOrBuilderpublic 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;getOrderByList in interface StructuredQueryOrBuilderpublic 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;getOrderByOrBuilderList in interface StructuredQueryOrBuilderpublic 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;getOrderByCount in interface StructuredQueryOrBuilderpublic 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;getOrderBy in interface StructuredQueryOrBuilderpublic 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;getOrderByOrBuilder in interface StructuredQueryOrBuilderpublic boolean hasStartAt()
A starting point for the query results.
.google.firestore.v1beta1.Cursor start_at = 7;hasStartAt in interface StructuredQueryOrBuilderpublic Cursor getStartAt()
A starting point for the query results.
.google.firestore.v1beta1.Cursor start_at = 7;getStartAt in interface StructuredQueryOrBuilderpublic CursorOrBuilder getStartAtOrBuilder()
A starting point for the query results.
.google.firestore.v1beta1.Cursor start_at = 7;getStartAtOrBuilder in interface StructuredQueryOrBuilderpublic boolean hasEndAt()
A end point for the query results.
.google.firestore.v1beta1.Cursor end_at = 8;hasEndAt in interface StructuredQueryOrBuilderpublic Cursor getEndAt()
A end point for the query results.
.google.firestore.v1beta1.Cursor end_at = 8;getEndAt in interface StructuredQueryOrBuilderpublic CursorOrBuilder getEndAtOrBuilder()
A end point for the query results.
.google.firestore.v1beta1.Cursor end_at = 8;getEndAtOrBuilder in interface StructuredQueryOrBuilderpublic int getOffset()
The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.
int32 offset = 6;getOffset in interface StructuredQueryOrBuilderpublic boolean hasLimit()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;hasLimit in interface StructuredQueryOrBuilderpublic Int32Value getLimit()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;getLimit in interface StructuredQueryOrBuilderpublic Int32ValueOrBuilder getLimitOrBuilder()
The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 5;getLimitOrBuilder in interface StructuredQueryOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3java.io.IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(java.lang.Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static StructuredQuery parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static StructuredQuery parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static StructuredQuery parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOExceptionpublic static StructuredQuery parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic static StructuredQuery parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOExceptionpublic static StructuredQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOExceptionpublic StructuredQuery.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static StructuredQuery.Builder newBuilder()
public static StructuredQuery.Builder newBuilder(StructuredQuery prototype)
public StructuredQuery.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected StructuredQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static StructuredQuery getDefaultInstance()
public static Parser<StructuredQuery> parser()
public Parser<StructuredQuery> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public StructuredQuery getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilder