Show / Hide Table of Contents

Class RunAggregationQueryRequest

The request for Firestore.RunAggregationQuery.

Inheritance
object
RunAggregationQueryRequest
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.Firestore.v1beta1.Data
Assembly: Google.Apis.Firestore.v1beta1.dll
Syntax
public class RunAggregationQueryRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

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

ExplainOptions

Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.

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

NewTransaction

Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.

Declaration
[JsonProperty("newTransaction")]
public virtual TransactionOptions NewTransaction { get; set; }
Property Value
Type Description
TransactionOptions

ReadTime

object representation of ReadTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ReadTimeDateTimeOffset instead.")]
public virtual object ReadTime { get; set; }
Property Value
Type Description
object

ReadTimeDateTimeOffset

DateTimeOffset representation of ReadTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ReadTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ReadTimeRaw

Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

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

StructuredAggregationQuery

An aggregation query.

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

Transaction

Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX