Class Query.Builder (2.24.1)

Version latest

• 2.24.1 (latest)
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public static final class Query.Builder extends GeneratedMessageV3.Builder<Query.Builder> implements QueryOrBuilder

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Query.Builder

Implements

QueryOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllDistinctOn(Iterable<? extends PropertyReference> values)

public Query.Builder addAllDistinctOn(Iterable<? extends PropertyReference> values)

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
values	Iterable<? extends com.google.datastore.v1.PropertyReference>

Returns
Type	Description
Query.Builder

addAllKind(Iterable<? extends KindExpression> values)

public Query.Builder addAllKind(Iterable<? extends KindExpression> values)

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
values	Iterable<? extends com.google.datastore.v1.KindExpression>

Returns
Type	Description
Query.Builder

addAllOrder(Iterable<? extends PropertyOrder> values)

public Query.Builder addAllOrder(Iterable<? extends PropertyOrder> values)

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

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

Parameter
Name	Description
values	Iterable<? extends com.google.datastore.v1.PropertyOrder>

Returns
Type	Description
Query.Builder

addAllProjection(Iterable<? extends Projection> values)

public Query.Builder addAllProjection(Iterable<? extends Projection> values)

The projection to return. Defaults to returning all properties.

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

Parameter
Name	Description
values	Iterable<? extends com.google.datastore.v1.Projection>

Returns
Type	Description
Query.Builder

addDistinctOn(PropertyReference value)

public Query.Builder addDistinctOn(PropertyReference value)

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
value	PropertyReference

Returns
Type	Description
Query.Builder

addDistinctOn(PropertyReference.Builder builderForValue)

public Query.Builder addDistinctOn(PropertyReference.Builder builderForValue)

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
builderForValue	PropertyReference.Builder

Returns
Type	Description
Query.Builder

addDistinctOn(int index, PropertyReference value)

public Query.Builder addDistinctOn(int index, PropertyReference value)

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;

Parameters
Name	Description
index	int
value	PropertyReference

Returns
Type	Description
Query.Builder

addDistinctOn(int index, PropertyReference.Builder builderForValue)

public Query.Builder addDistinctOn(int index, PropertyReference.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	PropertyReference.Builder

Returns
Type	Description
Query.Builder

addDistinctOnBuilder()

public PropertyReference.Builder addDistinctOnBuilder()

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
PropertyReference.Builder

addDistinctOnBuilder(int index)

public PropertyReference.Builder addDistinctOnBuilder(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).

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.Builder

addKind(KindExpression value)

public Query.Builder addKind(KindExpression value)

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
value	KindExpression

Returns
Type	Description
Query.Builder

addKind(KindExpression.Builder builderForValue)

public Query.Builder addKind(KindExpression.Builder builderForValue)

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
builderForValue	KindExpression.Builder

Returns
Type	Description
Query.Builder

addKind(int index, KindExpression value)

public Query.Builder addKind(int index, KindExpression value)

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;

Parameters
Name	Description
index	int
value	KindExpression

Returns
Type	Description
Query.Builder

addKind(int index, KindExpression.Builder builderForValue)

public Query.Builder addKind(int index, KindExpression.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	KindExpression.Builder

Returns
Type	Description
Query.Builder

addKindBuilder()

public KindExpression.Builder addKindBuilder()

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
KindExpression.Builder

addKindBuilder(int index)

public KindExpression.Builder addKindBuilder(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;

Parameter
Name	Description
index	int

Returns
Type	Description
KindExpression.Builder

addOrder(PropertyOrder value)

public Query.Builder addOrder(PropertyOrder value)

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

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

Parameter
Name	Description
value	PropertyOrder

Returns
Type	Description
Query.Builder

addOrder(PropertyOrder.Builder builderForValue)

public Query.Builder addOrder(PropertyOrder.Builder builderForValue)

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

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

Parameter
Name	Description
builderForValue	PropertyOrder.Builder

Returns
Type	Description
Query.Builder

addOrder(int index, PropertyOrder value)

public Query.Builder addOrder(int index, PropertyOrder value)

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

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

Parameters
Name	Description
index	int
value	PropertyOrder

Returns
Type	Description
Query.Builder

addOrder(int index, PropertyOrder.Builder builderForValue)

public Query.Builder addOrder(int index, PropertyOrder.Builder builderForValue)

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

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

Parameters
Name	Description
index	int
builderForValue	PropertyOrder.Builder

Returns
Type	Description
Query.Builder

addOrderBuilder()

public PropertyOrder.Builder addOrderBuilder()

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

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

Returns
Type	Description
PropertyOrder.Builder

addOrderBuilder(int index)

public PropertyOrder.Builder addOrderBuilder(int index)

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.Builder

addProjection(Projection value)

public Query.Builder addProjection(Projection value)

The projection to return. Defaults to returning all properties.

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

Parameter
Name	Description
value	Projection

Returns
Type	Description
Query.Builder

addProjection(Projection.Builder builderForValue)

public Query.Builder addProjection(Projection.Builder builderForValue)

The projection to return. Defaults to returning all properties.

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

Parameter
Name	Description
builderForValue	Projection.Builder

Returns
Type	Description
Query.Builder

addProjection(int index, Projection value)

public Query.Builder addProjection(int index, Projection value)

The projection to return. Defaults to returning all properties.

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

Parameters
Name	Description
index	int
value	Projection

Returns
Type	Description
Query.Builder

addProjection(int index, Projection.Builder builderForValue)

public Query.Builder addProjection(int index, Projection.Builder builderForValue)

The projection to return. Defaults to returning all properties.

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

Parameters
Name	Description
index	int
builderForValue	Projection.Builder

Returns
Type	Description
Query.Builder

addProjectionBuilder()

public Projection.Builder addProjectionBuilder()

The projection to return. Defaults to returning all properties.

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

Returns
Type	Description
Projection.Builder

addProjectionBuilder(int index)

public Projection.Builder addProjectionBuilder(int index)

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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Query.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Query build()

Returns
Type	Description
Query

buildPartial()

public Query buildPartial()

Returns
Type	Description
Query

clear()

public Query.Builder clear()

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDistinctOn()

public Query.Builder clearDistinctOn()

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
Query.Builder

clearEndCursor()

public Query.Builder clearEndCursor()

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
Query.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Query.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public Query.Builder clearFilter()

The filter to apply.

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

Returns
Type	Description
Query.Builder

clearFindNearest()

public Query.Builder clearFindNearest()

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
Query.Builder

clearKind()

public Query.Builder clearKind()

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
Query.Builder

clearLimit()

public Query.Builder clearLimit()

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
Query.Builder

clearOffset()

public Query.Builder clearOffset()

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
Query.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Query.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearOrder()

public Query.Builder clearOrder()

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

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

Returns
Type	Description
Query.Builder

clearProjection()

public Query.Builder clearProjection()

The projection to return. Defaults to returning all properties.

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

Returns
Type	Description
Query.Builder

clearStartCursor()

public Query.Builder clearStartCursor()

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
Query.Builder	This builder for chaining.

clone()

public Query.Builder clone()

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Query getDefaultInstanceForType()

Returns
Type	Description
Query

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDistinctOn(int index)

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

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

getDistinctOnBuilder(int index)

public PropertyReference.Builder getDistinctOnBuilder(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).

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.Builder

getDistinctOnBuilderList()

public List<PropertyReference.Builder> getDistinctOnBuilderList()

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<Builder>

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;

Returns
Type	Description
int

getDistinctOnList()

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

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)

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

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()

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

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()

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.

bytes end_cursor = 8;

Returns
Type	Description
ByteString	The endCursor.

getFilter()

public Filter getFilter()

The filter to apply.

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

Returns
Type	Description
Filter	The filter.

getFilterBuilder()

public Filter.Builder getFilterBuilder()

The filter to apply.

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

Returns
Type	Description
Filter.Builder

getFilterOrBuilder()

public FilterOrBuilder getFilterOrBuilder()

The filter to apply.

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

Returns
Type	Description
FilterOrBuilder

getFindNearest()

public FindNearest getFindNearest()

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.

getFindNearestBuilder()

public FindNearest.Builder getFindNearestBuilder()

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.Builder

getFindNearestOrBuilder()

public FindNearestOrBuilder getFindNearestOrBuilder()

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)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
KindExpression

getKindBuilder(int index)

public KindExpression.Builder getKindBuilder(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;

Parameter
Name	Description
index	int

Returns
Type	Description
KindExpression.Builder

getKindBuilderList()

public List<KindExpression.Builder> getKindBuilderList()

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<Builder>

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;

Returns
Type	Description
int

getKindList()

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

Returns
Type	Description
List<KindExpression>

getKindOrBuilder(int index)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
KindExpressionOrBuilder

getKindOrBuilderList()

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

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

getLimit()

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;

Returns
Type	Description
Int32Value	The limit.

getLimitBuilder()

public Int32Value.Builder getLimitBuilder()

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
Builder

getLimitOrBuilder()

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;

Returns
Type	Description
Int32ValueOrBuilder

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;

Returns
Type	Description
int	The offset.

getOrder(int index)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
PropertyOrder

getOrderBuilder(int index)

public PropertyOrder.Builder getOrderBuilder(int index)

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.Builder

getOrderBuilderList()

public List<PropertyOrder.Builder> getOrderBuilderList()

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

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

Returns
Type	Description
List<Builder>

getOrderCount()

public int getOrderCount()

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()

public List<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)

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;

Parameter
Name	Description
index	int

Returns
Type	Description
PropertyOrderOrBuilder

getOrderOrBuilderList()

public List<? extends PropertyOrderOrBuilder> 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>

getProjection(int index)

public Projection getProjection(int index)

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

getProjectionBuilder(int index)

public Projection.Builder getProjectionBuilder(int index)

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.Builder

getProjectionBuilderList()

public List<Projection.Builder> getProjectionBuilderList()

The projection to return. Defaults to returning all properties.

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

Returns
Type	Description
List<Builder>

getProjectionCount()

public int getProjectionCount()

The projection to return. Defaults to returning all properties.

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

Returns
Type	Description
int

getProjectionList()

public List<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)

public ProjectionOrBuilder getProjectionOrBuilder(int index)

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()

public List<? extends ProjectionOrBuilder> 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>

getStartCursor()

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.

bytes start_cursor = 7;

Returns
Type	Description
ByteString	The startCursor.

hasFilter()

public boolean hasFilter()

The filter to apply.

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

Returns
Type	Description
boolean	Whether the filter field is set.

hasFindNearest()

public boolean hasFindNearest()

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()

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;

Returns
Type	Description
boolean	Whether the limit field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFilter(Filter value)

public Query.Builder mergeFilter(Filter value)

The filter to apply.

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

Parameter
Name	Description
value	Filter

Returns
Type	Description
Query.Builder

mergeFindNearest(FindNearest value)

public Query.Builder mergeFindNearest(FindNearest value)

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

Parameter
Name	Description
value	FindNearest

Returns
Type	Description
Query.Builder

mergeFrom(Query other)

public Query.Builder mergeFrom(Query other)

Parameter
Name	Description
other	Query

Returns
Type	Description
Query.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Query.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Query.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Query.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Query.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeLimit(Int32Value value)

public Query.Builder mergeLimit(Int32Value value)

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;

Parameter
Name	Description
value	Int32Value

Returns
Type	Description
Query.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Query.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeDistinctOn(int index)

public Query.Builder removeDistinctOn(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).

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
Query.Builder

removeKind(int index)

public Query.Builder removeKind(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;

Parameter
Name	Description
index	int

Returns
Type	Description
Query.Builder

removeOrder(int index)

public Query.Builder removeOrder(int index)

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
Query.Builder

removeProjection(int index)

public Query.Builder removeProjection(int index)

The projection to return. Defaults to returning all properties.

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

Parameter
Name	Description
index	int

Returns
Type	Description
Query.Builder

setDistinctOn(int index, PropertyReference value)

public Query.Builder setDistinctOn(int index, PropertyReference value)

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;

Parameters
Name	Description
index	int
value	PropertyReference

Returns
Type	Description
Query.Builder

setDistinctOn(int index, PropertyReference.Builder builderForValue)

public Query.Builder setDistinctOn(int index, PropertyReference.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	PropertyReference.Builder

Returns
Type	Description
Query.Builder

setEndCursor(ByteString value)

public Query.Builder setEndCursor(ByteString value)

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;

Parameter
Name	Description
value	ByteString The endCursor to set.

Returns
Type	Description
Query.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Query.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(Filter value)

public Query.Builder setFilter(Filter value)

The filter to apply.

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

Parameter
Name	Description
value	Filter

Returns
Type	Description
Query.Builder

setFilter(Filter.Builder builderForValue)

public Query.Builder setFilter(Filter.Builder builderForValue)

The filter to apply.

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

Parameter
Name	Description
builderForValue	Filter.Builder

Returns
Type	Description
Query.Builder

setFindNearest(FindNearest value)

public Query.Builder setFindNearest(FindNearest value)

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

Parameter
Name	Description
value	FindNearest

Returns
Type	Description
Query.Builder

setFindNearest(FindNearest.Builder builderForValue)

public Query.Builder setFindNearest(FindNearest.Builder builderForValue)

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

Parameter
Name	Description
builderForValue	FindNearest.Builder

Returns
Type	Description
Query.Builder

setKind(int index, KindExpression value)

public Query.Builder setKind(int index, KindExpression value)

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;

Parameters
Name	Description
index	int
value	KindExpression

Returns
Type	Description
Query.Builder

setKind(int index, KindExpression.Builder builderForValue)

public Query.Builder setKind(int index, KindExpression.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	KindExpression.Builder

Returns
Type	Description
Query.Builder

setLimit(Int32Value value)

public Query.Builder setLimit(Int32Value value)

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;

Parameter
Name	Description
value	Int32Value

Returns
Type	Description
Query.Builder

setLimit(Int32Value.Builder builderForValue)

public Query.Builder setLimit(Int32Value.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Query.Builder

setOffset(int value)

public Query.Builder setOffset(int value)

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

int32 offset = 10;

Parameter
Name	Description
value	int The offset to set.

Returns
Type	Description
Query.Builder	This builder for chaining.

setOrder(int index, PropertyOrder value)

public Query.Builder setOrder(int index, PropertyOrder value)

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

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

Parameters
Name	Description
index	int
value	PropertyOrder

Returns
Type	Description
Query.Builder

setOrder(int index, PropertyOrder.Builder builderForValue)

public Query.Builder setOrder(int index, PropertyOrder.Builder builderForValue)

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

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

Parameters
Name	Description
index	int
builderForValue	PropertyOrder.Builder

Returns
Type	Description
Query.Builder

setProjection(int index, Projection value)

public Query.Builder setProjection(int index, Projection value)

The projection to return. Defaults to returning all properties.

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

Parameters
Name	Description
index	int
value	Projection

Returns
Type	Description
Query.Builder

setProjection(int index, Projection.Builder builderForValue)

public Query.Builder setProjection(int index, Projection.Builder builderForValue)

The projection to return. Defaults to returning all properties.

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

Parameters
Name	Description
index	int
builderForValue	Projection.Builder

Returns
Type	Description
Query.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Query.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStartCursor(ByteString value)

public Query.Builder setStartCursor(ByteString value)

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;

Parameter
Name	Description
value	ByteString The startCursor to set.

Returns
Type	Description
Query.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Query.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Query.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)