public final class StructuredQuery extends com.google.protobuf.GeneratedMessageV3 implements StructuredQueryOrBuilder
A Firestore query.Protobuf type
google.firestore.v1.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 |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.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 |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static StructuredQuery |
getDefaultInstance() |
StructuredQuery |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
List<StructuredQuery.CollectionSelector> |
getFromList()
The collections to query.
|
StructuredQuery.CollectionSelectorOrBuilder |
getFromOrBuilder(int index)
The collections to query.
|
List<? extends StructuredQuery.CollectionSelectorOrBuilder> |
getFromOrBuilderList()
The collections to query.
|
com.google.protobuf.Int32Value |
getLimit()
The maximum number of results to return.
|
com.google.protobuf.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.
|
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.
|
List<? extends StructuredQuery.OrderOrBuilder> |
getOrderByOrBuilderList()
The order to apply to the query results.
|
com.google.protobuf.Parser<StructuredQuery> |
getParserForType() |
StructuredQuery.Projection |
getSelect()
The projection to return.
|
StructuredQuery.ProjectionOrBuilder |
getSelectOrBuilder()
The projection to return.
|
int |
getSerializedSize() |
Cursor |
getStartAt()
A starting point for the query results.
|
CursorOrBuilder |
getStartAtOrBuilder()
A starting point for the query results.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
StructuredQuery.Filter |
getWhere()
The filter to apply.
|
StructuredQuery.FilterOrBuilder |
getWhereOrBuilder()
The filter to apply.
|
boolean |
hasEndAt()
A end point for the query results.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static StructuredQuery.Builder |
newBuilder() |
static StructuredQuery.Builder |
newBuilder(StructuredQuery prototype) |
StructuredQuery.Builder |
newBuilderForType() |
protected StructuredQuery.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static StructuredQuery |
parseDelimitedFrom(InputStream input) |
static StructuredQuery |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StructuredQuery |
parseFrom(byte[] data) |
static StructuredQuery |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StructuredQuery |
parseFrom(ByteBuffer data) |
static StructuredQuery |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StructuredQuery |
parseFrom(com.google.protobuf.ByteString data) |
static StructuredQuery |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StructuredQuery |
parseFrom(com.google.protobuf.CodedInputStream input) |
static StructuredQuery |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StructuredQuery |
parseFrom(InputStream input) |
static StructuredQuery |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<StructuredQuery> |
parser() |
StructuredQuery.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, waitpublic 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 com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;hasSelect in interface StructuredQueryOrBuilderpublic StructuredQuery.Projection getSelect()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;getSelect in interface StructuredQueryOrBuilderpublic StructuredQuery.ProjectionOrBuilder getSelectOrBuilder()
The projection to return.
.google.firestore.v1.StructuredQuery.Projection select = 1;getSelectOrBuilder in interface StructuredQueryOrBuilderpublic List<StructuredQuery.CollectionSelector> getFromList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromList in interface StructuredQueryOrBuilderpublic List<? extends StructuredQuery.CollectionSelectorOrBuilder> getFromOrBuilderList()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromOrBuilderList in interface StructuredQueryOrBuilderpublic int getFromCount()
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromCount in interface StructuredQueryOrBuilderpublic StructuredQuery.CollectionSelector getFrom(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFrom in interface StructuredQueryOrBuilderpublic StructuredQuery.CollectionSelectorOrBuilder getFromOrBuilder(int index)
The collections to query.
repeated .google.firestore.v1.StructuredQuery.CollectionSelector from = 2;getFromOrBuilder in interface StructuredQueryOrBuilderpublic boolean hasWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;hasWhere in interface StructuredQueryOrBuilderpublic StructuredQuery.Filter getWhere()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;getWhere in interface StructuredQueryOrBuilderpublic StructuredQuery.FilterOrBuilder getWhereOrBuilder()
The filter to apply.
.google.firestore.v1.StructuredQuery.Filter where = 3;getWhereOrBuilder in interface StructuredQueryOrBuilderpublic 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.v1.StructuredQuery.Order order_by = 4;getOrderByList in interface StructuredQueryOrBuilderpublic 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.v1.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.v1.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.v1.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.v1.StructuredQuery.Order order_by = 4;getOrderByOrBuilder in interface StructuredQueryOrBuilderpublic boolean hasStartAt()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;hasStartAt in interface StructuredQueryOrBuilderpublic Cursor getStartAt()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;getStartAt in interface StructuredQueryOrBuilderpublic CursorOrBuilder getStartAtOrBuilder()
A starting point for the query results.
.google.firestore.v1.Cursor start_at = 7;getStartAtOrBuilder in interface StructuredQueryOrBuilderpublic boolean hasEndAt()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;hasEndAt in interface StructuredQueryOrBuilderpublic Cursor getEndAt()
A end point for the query results.
.google.firestore.v1.Cursor end_at = 8;getEndAt in interface StructuredQueryOrBuilderpublic CursorOrBuilder getEndAtOrBuilder()
A end point for the query results.
.google.firestore.v1.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static StructuredQuery parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StructuredQuery parseFrom(InputStream input) throws IOException
IOExceptionpublic static StructuredQuery parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StructuredQuery parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static StructuredQuery parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StructuredQuery parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static StructuredQuery parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic StructuredQuery.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static StructuredQuery.Builder newBuilder()
public static StructuredQuery.Builder newBuilder(StructuredQuery prototype)
public StructuredQuery.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected StructuredQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static StructuredQuery getDefaultInstance()
public static com.google.protobuf.Parser<StructuredQuery> parser()
public com.google.protobuf.Parser<StructuredQuery> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public StructuredQuery getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2019 Google LLC. All rights reserved.