Package com.google.datastore.v1
Class Query
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.Query
- All Implemented Interfaces:
QueryOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
A query for entities.Protobuf type
google.datastore.v1.Query
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static Query
static final com.google.protobuf.Descriptors.Descriptor
getDistinctOn
(int index) The properties to make distinct.int
The properties to make distinct.The properties to make distinct.getDistinctOnOrBuilder
(int index) The properties to make distinct.List<? extends PropertyReferenceOrBuilder>
The properties to make distinct.com.google.protobuf.ByteString
An ending point for the query results.The filter to apply.The filter to apply.getKind
(int index) The kinds to query (if empty, returns entities of all kinds).int
The kinds to query (if empty, returns entities of all kinds).The kinds to query (if empty, returns entities of all kinds).getKindOrBuilder
(int index) The kinds to query (if empty, returns entities of all kinds).List<? extends KindExpressionOrBuilder>
The kinds to query (if empty, returns entities of all kinds).com.google.protobuf.Int32Value
getLimit()
The maximum number of results to return.com.google.protobuf.Int32ValueOrBuilder
The maximum number of results to return.int
The number of results to skip.getOrder
(int index) The order to apply to the query results (if empty, order is unspecified).int
The order to apply to the query results (if empty, order is unspecified).The order to apply to the query results (if empty, order is unspecified).getOrderOrBuilder
(int index) The order to apply to the query results (if empty, order is unspecified).List<? extends PropertyOrderOrBuilder>
The order to apply to the query results (if empty, order is unspecified).com.google.protobuf.Parser<Query>
getProjection
(int index) The projection to return.int
The projection to return.The projection to return.getProjectionOrBuilder
(int index) The projection to return.List<? extends ProjectionOrBuilder>
The projection to return.int
com.google.protobuf.ByteString
A starting point for the query results.boolean
The filter to apply.int
hashCode()
boolean
hasLimit()
The maximum number of results to return.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static Query.Builder
static Query.Builder
newBuilder
(Query prototype) protected Query.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static Query
parseDelimitedFrom
(InputStream input) static Query
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Query
parseFrom
(byte[] data) static Query
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Query
parseFrom
(com.google.protobuf.ByteString data) static Query
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Query
parseFrom
(com.google.protobuf.CodedInputStream input) static Query
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Query
parseFrom
(InputStream input) static Query
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Query
parseFrom
(ByteBuffer data) static Query
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Query>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, 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, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
PROJECTION_FIELD_NUMBER
public static final int PROJECTION_FIELD_NUMBER- See Also:
-
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER- See Also:
-
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER- See Also:
-
ORDER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER- See Also:
-
DISTINCT_ON_FIELD_NUMBER
public static final int DISTINCT_ON_FIELD_NUMBER- See Also:
-
START_CURSOR_FIELD_NUMBER
public static final int START_CURSOR_FIELD_NUMBER- See Also:
-
END_CURSOR_FIELD_NUMBER
public static final int END_CURSOR_FIELD_NUMBER- See Also:
-
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER- See Also:
-
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getProjectionList
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
- Specified by:
getProjectionList
in interfaceQueryOrBuilder
-
getProjectionOrBuilderList
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
- Specified by:
getProjectionOrBuilderList
in interfaceQueryOrBuilder
-
getProjectionCount
public int getProjectionCount()The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
- Specified by:
getProjectionCount
in interfaceQueryOrBuilder
-
getProjection
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
- Specified by:
getProjection
in interfaceQueryOrBuilder
-
getProjectionOrBuilder
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
- Specified by:
getProjectionOrBuilder
in interfaceQueryOrBuilder
-
getKindList
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
repeated .google.datastore.v1.KindExpression kind = 3;
- Specified by:
getKindList
in interfaceQueryOrBuilder
-
getKindOrBuilderList
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
repeated .google.datastore.v1.KindExpression kind = 3;
- Specified by:
getKindOrBuilderList
in interfaceQueryOrBuilder
-
getKindCount
public int getKindCount()The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
repeated .google.datastore.v1.KindExpression kind = 3;
- Specified by:
getKindCount
in interfaceQueryOrBuilder
-
getKind
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
repeated .google.datastore.v1.KindExpression kind = 3;
- Specified by:
getKind
in interfaceQueryOrBuilder
-
getKindOrBuilder
The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.
repeated .google.datastore.v1.KindExpression kind = 3;
- Specified by:
getKindOrBuilder
in interfaceQueryOrBuilder
-
hasFilter
public boolean hasFilter()The filter to apply.
.google.datastore.v1.Filter filter = 4;
- Specified by:
hasFilter
in interfaceQueryOrBuilder
- Returns:
- Whether the filter field is set.
-
getFilter
The filter to apply.
.google.datastore.v1.Filter filter = 4;
- Specified by:
getFilter
in interfaceQueryOrBuilder
- Returns:
- The filter.
-
getFilterOrBuilder
The filter to apply.
.google.datastore.v1.Filter filter = 4;
- Specified by:
getFilterOrBuilder
in interfaceQueryOrBuilder
-
getOrderList
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
- Specified by:
getOrderList
in interfaceQueryOrBuilder
-
getOrderOrBuilderList
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
- Specified by:
getOrderOrBuilderList
in interfaceQueryOrBuilder
-
getOrderCount
public int getOrderCount()The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
- Specified by:
getOrderCount
in interfaceQueryOrBuilder
-
getOrder
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
- Specified by:
getOrder
in interfaceQueryOrBuilder
-
getOrderOrBuilder
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
- Specified by:
getOrderOrBuilder
in interfaceQueryOrBuilder
-
getDistinctOnList
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
- Specified by:
getDistinctOnList
in interfaceQueryOrBuilder
-
getDistinctOnOrBuilderList
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
- Specified by:
getDistinctOnOrBuilderList
in interfaceQueryOrBuilder
-
getDistinctOnCount
public int getDistinctOnCount()The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
- Specified by:
getDistinctOnCount
in interfaceQueryOrBuilder
-
getDistinctOn
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
- Specified by:
getDistinctOn
in interfaceQueryOrBuilder
-
getDistinctOnOrBuilder
The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned). Requires: * If `order` is specified, the set of distinct on properties must appear before the non-distinct on properties in `order`.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
- Specified by:
getDistinctOnOrBuilder
in interfaceQueryOrBuilder
-
getStartCursor
public com.google.protobuf.ByteString getStartCursor()A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
bytes start_cursor = 7;
- Specified by:
getStartCursor
in interfaceQueryOrBuilder
- Returns:
- The startCursor.
-
getEndCursor
public com.google.protobuf.ByteString getEndCursor()An ending point for the query results. Query cursors are returned in query result batches and [can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
bytes end_cursor = 8;
- Specified by:
getEndCursor
in interfaceQueryOrBuilder
- Returns:
- The endCursor.
-
getOffset
public int getOffset()The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.
int32 offset = 10;
- Specified by:
getOffset
in interfaceQueryOrBuilder
- Returns:
- The offset.
-
hasLimit
public boolean hasLimit()The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 12;
- Specified by:
hasLimit
in interfaceQueryOrBuilder
- Returns:
- Whether the limit field is set.
-
getLimit
public com.google.protobuf.Int32Value getLimit()The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 12;
- Specified by:
getLimit
in interfaceQueryOrBuilder
- Returns:
- The limit.
-
getLimitOrBuilder
public com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.
.google.protobuf.Int32Value limit = 12;
- Specified by:
getLimitOrBuilder
in interfaceQueryOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Query parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Query parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Query parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Query parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Query parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Query parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Query parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Query parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Query parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Query.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-