Firestore v1 API - Class RunAggregationQueryRequest (3.6.0) 

public sealed class RunAggregationQueryRequest : IMessage<RunAggregationQueryRequest>, IEquatable<RunAggregationQueryRequest>, IDeepCloneable<RunAggregationQueryRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class RunAggregationQueryRequest.

The request for [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].

Inheritance

object > RunAggregationQueryRequest

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

RunAggregationQueryRequest()

public RunAggregationQueryRequest()

RunAggregationQueryRequest(RunAggregationQueryRequest)

public RunAggregationQueryRequest(RunAggregationQueryRequest other)
Parameter
Name Description
other RunAggregationQueryRequest

Properties

ConsistencySelectorCase

public RunAggregationQueryRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }
Property Value
Type Description
RunAggregationQueryRequestConsistencySelectorOneofCase

ExplainOptions

public ExplainOptions ExplainOptions { get; set; }

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

Property Value
Type Description
ExplainOptions

HasTransaction

public bool HasTransaction { get; }

Gets whether the "transaction" field is set

Property Value
Type Description
bool

NewTransaction

public TransactionOptions NewTransaction { get; set; }

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.

Property Value
Type Description
TransactionOptions

Parent

public string Parent { get; set; }

Required. The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

Property Value
Type Description
string

QueryTypeCase

public RunAggregationQueryRequest.QueryTypeOneofCase QueryTypeCase { get; }
Property Value
Type Description
RunAggregationQueryRequestQueryTypeOneofCase

ReadTime

public Timestamp ReadTime { get; set; }

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.

Property Value
Type Description
Timestamp

StructuredAggregationQuery

public StructuredAggregationQuery StructuredAggregationQuery { get; set; }

An aggregation query.

Property Value
Type Description
StructuredAggregationQuery

Transaction

public ByteString Transaction { get; set; }

Run the aggregation within an already active transaction.

The value here is the opaque transaction ID to execute the query in.

Property Value
Type Description
ByteString