public final class Query extends GeneratedMessageV3 implements QueryOrBuilder
A query for entities.Protobuf type
google.datastore.v1.Query
Modifier and Type | Class and Description |
---|---|
static class |
Query.Builder
A query for entities.
|
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 |
DISTINCT_ON_FIELD_NUMBER |
static int |
END_CURSOR_FIELD_NUMBER |
static int |
FILTER_FIELD_NUMBER |
static int |
KIND_FIELD_NUMBER |
static int |
LIMIT_FIELD_NUMBER |
static int |
OFFSET_FIELD_NUMBER |
static int |
ORDER_FIELD_NUMBER |
static int |
PROJECTION_FIELD_NUMBER |
static int |
START_CURSOR_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFields
memoizedSize
memoizedHashCode
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
static Query |
getDefaultInstance() |
Query |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
PropertyReference |
getDistinctOn(int index)
The properties to make distinct.
|
int |
getDistinctOnCount()
The properties to make distinct.
|
java.util.List<PropertyReference> |
getDistinctOnList()
The properties to make distinct.
|
PropertyReferenceOrBuilder |
getDistinctOnOrBuilder(int index)
The properties to make distinct.
|
java.util.List<? extends PropertyReferenceOrBuilder> |
getDistinctOnOrBuilderList()
The properties to make distinct.
|
ByteString |
getEndCursor()
An ending point for the query results.
|
Filter |
getFilter()
The filter to apply.
|
FilterOrBuilder |
getFilterOrBuilder()
The filter to apply.
|
KindExpression |
getKind(int index)
The kinds to query (if empty, returns entities of all kinds).
|
int |
getKindCount()
The kinds to query (if empty, returns entities of all kinds).
|
java.util.List<KindExpression> |
getKindList()
The kinds to query (if empty, returns entities of all kinds).
|
KindExpressionOrBuilder |
getKindOrBuilder(int index)
The kinds to query (if empty, returns entities of all kinds).
|
java.util.List<? extends KindExpressionOrBuilder> |
getKindOrBuilderList()
The kinds to query (if empty, returns entities of all kinds).
|
Int32Value |
getLimit()
The maximum number of results to return.
|
Int32ValueOrBuilder |
getLimitOrBuilder()
The maximum number of results to return.
|
int |
getOffset()
The number of results to skip.
|
PropertyOrder |
getOrder(int index)
The order to apply to the query results (if empty, order is unspecified).
|
int |
getOrderCount()
The order to apply to the query results (if empty, order is unspecified).
|
java.util.List<PropertyOrder> |
getOrderList()
The order to apply to the query results (if empty, order is unspecified).
|
PropertyOrderOrBuilder |
getOrderOrBuilder(int index)
The order to apply to the query results (if empty, order is unspecified).
|
java.util.List<? extends PropertyOrderOrBuilder> |
getOrderOrBuilderList()
The order to apply to the query results (if empty, order is unspecified).
|
Parser<Query> |
getParserForType() |
Projection |
getProjection(int index)
The projection to return.
|
int |
getProjectionCount()
The projection to return.
|
java.util.List<Projection> |
getProjectionList()
The projection to return.
|
ProjectionOrBuilder |
getProjectionOrBuilder(int index)
The projection to return.
|
java.util.List<? extends ProjectionOrBuilder> |
getProjectionOrBuilderList()
The projection to return.
|
int |
getSerializedSize() |
ByteString |
getStartCursor()
A starting point for the query results.
|
UnknownFieldSet |
getUnknownFields() |
boolean |
hasFilter()
The filter to apply.
|
int |
hashCode() |
boolean |
hasLimit()
The maximum number of results to return.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Query.Builder |
newBuilder() |
static Query.Builder |
newBuilder(Query prototype) |
Query.Builder |
newBuilderForType() |
protected Query.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent) |
static Query |
parseDelimitedFrom(java.io.InputStream input) |
static Query |
parseDelimitedFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Query |
parseFrom(byte[] data) |
static Query |
parseFrom(byte[] data,
ExtensionRegistryLite extensionRegistry) |
static Query |
parseFrom(java.nio.ByteBuffer data) |
static Query |
parseFrom(java.nio.ByteBuffer data,
ExtensionRegistryLite extensionRegistry) |
static Query |
parseFrom(ByteString data) |
static Query |
parseFrom(ByteString data,
ExtensionRegistryLite extensionRegistry) |
static Query |
parseFrom(CodedInputStream input) |
static Query |
parseFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
static Query |
parseFrom(java.io.InputStream input) |
static Query |
parseFrom(java.io.InputStream input,
ExtensionRegistryLite extensionRegistry) |
static Parser<Query> |
parser() |
Query.Builder |
toBuilder() |
void |
writeTo(CodedOutputStream output) |
canUseUnsafe, 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, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
toByteArray, toByteString, writeDelimitedTo, writeTo
public static final int PROJECTION_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
public static final int ORDER_FIELD_NUMBER
public static final int DISTINCT_ON_FIELD_NUMBER
public static final int START_CURSOR_FIELD_NUMBER
public static final int END_CURSOR_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
public final UnknownFieldSet getUnknownFields()
getUnknownFields
in interface MessageOrBuilder
getUnknownFields
in class GeneratedMessageV3
public static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class GeneratedMessageV3
public java.util.List<Projection> getProjectionList()
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
getProjectionList
in interface QueryOrBuilder
public java.util.List<? extends ProjectionOrBuilder> getProjectionOrBuilderList()
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
getProjectionOrBuilderList
in interface QueryOrBuilder
public int getProjectionCount()
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
getProjectionCount
in interface QueryOrBuilder
public Projection getProjection(int index)
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
getProjection
in interface QueryOrBuilder
public ProjectionOrBuilder getProjectionOrBuilder(int index)
The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
getProjectionOrBuilder
in interface QueryOrBuilder
public java.util.List<KindExpression> 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;
getKindList
in interface QueryOrBuilder
public java.util.List<? extends KindExpressionOrBuilder> 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;
getKindOrBuilderList
in interface QueryOrBuilder
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;
getKindCount
in interface QueryOrBuilder
public KindExpression getKind(int index)
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;
getKind
in interface QueryOrBuilder
public KindExpressionOrBuilder getKindOrBuilder(int index)
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;
getKindOrBuilder
in interface QueryOrBuilder
public boolean hasFilter()
The filter to apply.
.google.datastore.v1.Filter filter = 4;
hasFilter
in interface QueryOrBuilder
public Filter getFilter()
The filter to apply.
.google.datastore.v1.Filter filter = 4;
getFilter
in interface QueryOrBuilder
public FilterOrBuilder getFilterOrBuilder()
The filter to apply.
.google.datastore.v1.Filter filter = 4;
getFilterOrBuilder
in interface QueryOrBuilder
public java.util.List<PropertyOrder> getOrderList()
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
getOrderList
in interface QueryOrBuilder
public java.util.List<? extends PropertyOrderOrBuilder> getOrderOrBuilderList()
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
getOrderOrBuilderList
in interface QueryOrBuilder
public int getOrderCount()
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
getOrderCount
in interface QueryOrBuilder
public PropertyOrder getOrder(int index)
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
getOrder
in interface QueryOrBuilder
public PropertyOrderOrBuilder getOrderOrBuilder(int index)
The order to apply to the query results (if empty, order is unspecified).
repeated .google.datastore.v1.PropertyOrder order = 5;
getOrderOrBuilder
in interface QueryOrBuilder
public java.util.List<PropertyReference> 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).
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
getDistinctOnList
in interface QueryOrBuilder
public java.util.List<? extends PropertyReferenceOrBuilder> 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).
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
getDistinctOnOrBuilderList
in interface QueryOrBuilder
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).
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
getDistinctOnCount
in interface QueryOrBuilder
public PropertyReference getDistinctOn(int index)
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).
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
getDistinctOn
in interface QueryOrBuilder
public PropertyReferenceOrBuilder getDistinctOnOrBuilder(int index)
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).
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
getDistinctOnOrBuilder
in interface QueryOrBuilder
public 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;
getStartCursor
in interface QueryOrBuilder
public 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;
getEndCursor
in interface QueryOrBuilder
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;
getOffset
in interface QueryOrBuilder
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;
hasLimit
in interface QueryOrBuilder
public 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;
getLimit
in interface QueryOrBuilder
public 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;
getLimitOrBuilder
in interface QueryOrBuilder
public final boolean isInitialized()
isInitialized
in interface MessageLiteOrBuilder
isInitialized
in class GeneratedMessageV3
public void writeTo(CodedOutputStream output) throws java.io.IOException
writeTo
in interface MessageLite
writeTo
in class GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface MessageLite
getSerializedSize
in class GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface Message
equals
in class AbstractMessage
public int hashCode()
hashCode
in interface Message
hashCode
in class AbstractMessage
public static Query parseFrom(java.nio.ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Query parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Query parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Query parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Query parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Query parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferException
public static Query parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Query parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Query parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Query parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Query parseFrom(CodedInputStream input) throws java.io.IOException
java.io.IOException
public static Query parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public Query.Builder newBuilderForType()
newBuilderForType
in interface Message
newBuilderForType
in interface MessageLite
public static Query.Builder newBuilder()
public static Query.Builder newBuilder(Query prototype)
public Query.Builder toBuilder()
toBuilder
in interface Message
toBuilder
in interface MessageLite
protected Query.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class GeneratedMessageV3
public static Query getDefaultInstance()
public Parser<Query> getParserForType()
getParserForType
in interface Message
getParserForType
in interface MessageLite
getParserForType
in class GeneratedMessageV3
public Query getDefaultInstanceForType()
getDefaultInstanceForType
in interface MessageLiteOrBuilder
getDefaultInstanceForType
in interface MessageOrBuilder