Interface QueryOrBuilder (2.32.3)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface QueryOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getDistinctOn(int index)
publicabstractPropertyReferencegetDistinctOn(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
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PropertyReference |
|
getDistinctOnCount()
publicabstractintgetDistinctOnCount()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
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDistinctOnList()
publicabstractList<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
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
| Returns | |
|---|---|
| Type | Description |
List<PropertyReference> |
|
getDistinctOnOrBuilder(int index)
publicabstractPropertyReferenceOrBuildergetDistinctOnOrBuilder(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
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
PropertyReferenceOrBuilder |
|
getDistinctOnOrBuilderList()
publicabstractList<?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
orderis specified, the set of distinct on properties must appear before the non-distinct on properties inorder.
repeated .google.datastore.v1.PropertyReference distinct_on = 6;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.datastore.v1.PropertyReferenceOrBuilder> |
|
getEndCursor()
publicabstractByteStringgetEndCursor()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()
publicabstractFiltergetFilter()The filter to apply.
.google.datastore.v1.Filter filter = 4;
| Returns | |
|---|---|
| Type | Description |
Filter |
The filter. |
getFilterOrBuilder()
publicabstractFilterOrBuildergetFilterOrBuilder()The filter to apply.
.google.datastore.v1.Filter filter = 4;
| Returns | |
|---|---|
| Type | Description |
FilterOrBuilder |
|
getFindNearest()
publicabstractFindNearestgetFindNearest()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()
publicabstractFindNearestOrBuildergetFindNearestOrBuilder()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)
publicabstractKindExpressiongetKind(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()
publicabstractintgetKindCount()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()
publicabstractList<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)
publicabstractKindExpressionOrBuildergetKindOrBuilder(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()
publicabstractList<?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()
publicabstractInt32ValuegetLimit()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()
publicabstractInt32ValueOrBuildergetLimitOrBuilder()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()
publicabstractintgetOffset()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)
publicabstractPropertyOrdergetOrder(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()
publicabstractintgetOrderCount()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()
publicabstractList<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)
publicabstractPropertyOrderOrBuildergetOrderOrBuilder(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()
publicabstractList<?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> |
|
getProjection(int index)
publicabstractProjectiongetProjection(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()
publicabstractintgetProjectionCount()The projection to return. Defaults to returning all properties.
repeated .google.datastore.v1.Projection projection = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getProjectionList()
publicabstractList<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)
publicabstractProjectionOrBuildergetProjectionOrBuilder(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()
publicabstractList<?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> |
|
getStartCursor()
publicabstractByteStringgetStartCursor()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()
publicabstractbooleanhasFilter()The filter to apply.
.google.datastore.v1.Filter filter = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the filter field is set. |
hasFindNearest()
publicabstractbooleanhasFindNearest()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()
publicabstractbooleanhasLimit()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. |