Show / Hide Table of Contents

Class Query

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

Inheritance
object
Query
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Datastore.v1beta3.Data
Assembly: Google.Apis.Datastore.v1beta3.dll
Syntax
public class Query : IDirectResponseSchema

Properties

DistinctOn

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.

Declaration
[JsonProperty("distinctOn")]
public virtual IList<PropertyReference> DistinctOn { get; set; }
Property Value
Type Description
IList<PropertyReference>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndCursor

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.

Declaration
[JsonProperty("endCursor")]
public virtual string EndCursor { get; set; }
Property Value
Type Description
string

Filter

The filter to apply.

Declaration
[JsonProperty("filter")]
public virtual Filter Filter { get; set; }
Property Value
Type Description
Filter

FindNearest

Optional. A potential Nearest Neighbors Search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector.

Declaration
[JsonProperty("findNearest")]
public virtual FindNearest FindNearest { get; set; }
Property Value
Type Description
FindNearest

Kind

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

Declaration
[JsonProperty("kind")]
public virtual IList<KindExpression> Kind { get; set; }
Property Value
Type Description
IList<KindExpression>

Limit

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be &gt;= 0 if specified.

Declaration
[JsonProperty("limit")]
public virtual int? Limit { get; set; }
Property Value
Type Description
int?

Offset

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

Declaration
[JsonProperty("offset")]
public virtual int? Offset { get; set; }
Property Value
Type Description
int?

Order

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

Declaration
[JsonProperty("order")]
public virtual IList<PropertyOrder> Order { get; set; }
Property Value
Type Description
IList<PropertyOrder>

Projection

The projection to return. Defaults to returning all properties.

Declaration
[JsonProperty("projection")]
public virtual IList<Projection> Projection { get; set; }
Property Value
Type Description
IList<Projection>

StartCursor

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.

Declaration
[JsonProperty("startCursor")]
public virtual string StartCursor { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX