Interface QueryOrBuilder (2.24.1) 

public interface QueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDistinctOn(int index)

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

getDistinctOnCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Filter getFilter()

The filter to apply.

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

Returns
Type Description
Filter

The filter.

getFilterOrBuilder()

public abstract FilterOrBuilder getFilterOrBuilder()

The filter to apply.

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

Returns
Type Description
FilterOrBuilder

getFindNearest()

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

getFindNearestOrBuilder()

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

getKindCount()

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

getLimitOrBuilder()

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

getOrderCount()

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

getProjectionCount()

public abstract int getProjectionCount()

The projection to return. Defaults to returning all properties.

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

Returns
Type Description
int

getProjectionList()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasFilter()

The filter to apply.

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

Returns
Type Description
boolean

Whether the filter field is set.

hasFindNearest()

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