Class Query (2.24.3) 

publicfinalclass QueryextendsGeneratedMessageV3implementsQueryOrBuilder

A query for entities.

The query stages are executed in the following order:

  1. kind
  2. filter
  3. projection
  4. order + start_cursor + end_cursor
  5. offset
  6. limit
  7. find_nearest

Protobuf type google.datastore.v1.Query

Implements

QueryOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

DISTINCT_ON_FIELD_NUMBER

publicstaticfinalintDISTINCT_ON_FIELD_NUMBER
Field Value
Type Description
int

END_CURSOR_FIELD_NUMBER

publicstaticfinalintEND_CURSOR_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

publicstaticfinalintFILTER_FIELD_NUMBER
Field Value
Type Description
int

FIND_NEAREST_FIELD_NUMBER

publicstaticfinalintFIND_NEAREST_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

publicstaticfinalintKIND_FIELD_NUMBER
Field Value
Type Description
int

LIMIT_FIELD_NUMBER

publicstaticfinalintLIMIT_FIELD_NUMBER
Field Value
Type Description
int

OFFSET_FIELD_NUMBER

publicstaticfinalintOFFSET_FIELD_NUMBER
Field Value
Type Description
int

ORDER_FIELD_NUMBER

publicstaticfinalintORDER_FIELD_NUMBER
Field Value
Type Description
int

PROJECTION_FIELD_NUMBER

publicstaticfinalintPROJECTION_FIELD_NUMBER
Field Value
Type Description
int

START_CURSOR_FIELD_NUMBER

publicstaticfinalintSTART_CURSOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticQuerygetDefaultInstance()
Returns
Type Description
Query

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticQuery.BuildernewBuilder()
Returns
Type Description
Query.Builder

newBuilder(Query prototype)

publicstaticQuery.BuildernewBuilder(Queryprototype)
Parameter
Name Description
prototype Query
Returns
Type Description
Query.Builder

parseDelimitedFrom(InputStream input)

publicstaticQueryparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Query
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQueryparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Query
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticQueryparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticQueryparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticQueryparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticQueryparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticQueryparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Query
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQueryparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Query
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticQueryparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
Query
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQueryparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Query
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticQueryparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Query
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticQueryparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Query
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<Query>parser()
Returns
Type Description
Parser<Query>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicQuerygetDefaultInstanceForType()
Returns
Type Description
Query

getDistinctOn(int index)

publicPropertyReferencegetDistinctOn(intindex)

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;

Parameter
Name Description
index int
Returns
Type Description
PropertyReference

getDistinctOnCount()

publicintgetDistinctOnCount()

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;

Returns
Type Description
int

getDistinctOnList()

publicList<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).

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;

Returns
Type Description
List<PropertyReference>

getDistinctOnOrBuilder(int index)

publicPropertyReferenceOrBuildergetDistinctOnOrBuilder(intindex)

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;

Parameter
Name Description
index int
Returns
Type Description
PropertyReferenceOrBuilder

getDistinctOnOrBuilderList()

publicList<?extendsPropertyReferenceOrBuilder>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;

Returns
Type Description
List<? extends com.google.datastore.v1.PropertyReferenceOrBuilder>

getEndCursor()

publicByteStringgetEndCursor()

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.

bytes end_cursor = 8;

Returns
Type Description
ByteString

The endCursor.

getFilter()

publicFiltergetFilter()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
Type Description
Filter

The filter.

getFilterOrBuilder()

publicFilterOrBuildergetFilterOrBuilder()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
Type Description
FilterOrBuilder

getFindNearest()

publicFindNearestgetFindNearest()

Optional. A potential Nearest Neighbors Search.

Applies after all other filters and ordering.

Finds the closest vector embeddings to the given query vector.

.google.datastore.v1.FindNearest find_nearest = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FindNearest

The findNearest.

getFindNearestOrBuilder()

publicFindNearestOrBuildergetFindNearestOrBuilder()

Optional. A potential Nearest Neighbors Search.

Applies after all other filters and ordering.

Finds the closest vector embeddings to the given query vector.

.google.datastore.v1.FindNearest find_nearest = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FindNearestOrBuilder

getKind(int index)

publicKindExpressiongetKind(intindex)

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;

Parameter
Name Description
index int
Returns
Type Description
KindExpression

getKindCount()

publicintgetKindCount()

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;

Returns
Type Description
int

getKindList()

publicList<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;

Returns
Type Description
List<KindExpression>

getKindOrBuilder(int index)

publicKindExpressionOrBuildergetKindOrBuilder(intindex)

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;

Parameter
Name Description
index int
Returns
Type Description
KindExpressionOrBuilder

getKindOrBuilderList()

publicList<?extendsKindExpressionOrBuilder>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;

Returns
Type Description
List<? extends com.google.datastore.v1.KindExpressionOrBuilder>

getLimit()

publicInt32ValuegetLimit()

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;

Returns
Type Description
Int32Value

The limit.

getLimitOrBuilder()

publicInt32ValueOrBuildergetLimitOrBuilder()

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;

Returns
Type Description
Int32ValueOrBuilder

getOffset()

publicintgetOffset()

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.

int32 offset = 10;

Returns
Type Description
int

The offset.

getOrder(int index)

publicPropertyOrdergetOrder(intindex)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
Name Description
index int
Returns
Type Description
PropertyOrder

getOrderCount()

publicintgetOrderCount()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
Type Description
int

getOrderList()

publicList<PropertyOrder>getOrderList()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
Type Description
List<PropertyOrder>

getOrderOrBuilder(int index)

publicPropertyOrderOrBuildergetOrderOrBuilder(intindex)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
Name Description
index int
Returns
Type Description
PropertyOrderOrBuilder

getOrderOrBuilderList()

publicList<?extendsPropertyOrderOrBuilder>getOrderOrBuilderList()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
Type Description
List<? extends com.google.datastore.v1.PropertyOrderOrBuilder>

getParserForType()

publicParser<Query>getParserForType()
Returns
Type Description
Parser<Query>
Overrides

getProjection(int index)

publicProjectiongetProjection(intindex)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
Name Description
index int
Returns
Type Description
Projection

getProjectionCount()

publicintgetProjectionCount()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
Type Description
int

getProjectionList()

publicList<Projection>getProjectionList()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
Type Description
List<Projection>

getProjectionOrBuilder(int index)

publicProjectionOrBuildergetProjectionOrBuilder(intindex)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
Name Description
index int
Returns
Type Description
ProjectionOrBuilder

getProjectionOrBuilderList()

publicList<?extendsProjectionOrBuilder>getProjectionOrBuilderList()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
Type Description
List<? extends com.google.datastore.v1.ProjectionOrBuilder>

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getStartCursor()

publicByteStringgetStartCursor()

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.

bytes start_cursor = 7;

Returns
Type Description
ByteString

The startCursor.

hasFilter()

publicbooleanhasFilter()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
Type Description
boolean

Whether the filter field is set.

hasFindNearest()

publicbooleanhasFindNearest()

Optional. A potential Nearest Neighbors Search.

Applies after all other filters and ordering.

Finds the closest vector embeddings to the given query vector.

.google.datastore.v1.FindNearest find_nearest = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the findNearest field is set.

hasLimit()

publicbooleanhasLimit()

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;

Returns
Type Description
boolean

Whether the limit field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicQuery.BuildernewBuilderForType()
Returns
Type Description
Query.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedQuery.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Query.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicQuery.BuildertoBuilder()
Returns
Type Description
Query.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.