Class ProjectsResource.DatabasesResource.DocumentsResource.RunAggregationQueryRequest

Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example:

-- Return the number of documents in table given a filter. SELECT COUNT(*) FROM (
SELECT * FROM k where a = true );
Inheritance
object
ClientServiceRequest
ClientServiceRequest<RunAggregationQueryResponse>
FirestoreBaseServiceRequest<RunAggregationQueryResponse>
ProjectsResource.DatabasesResource.DocumentsResource.RunAggregationQueryRequest
Implements
Inherited Members
Namespace: Google.Apis.Firestore.v1
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class ProjectsResource.DatabasesResource.DocumentsResource.RunAggregationQueryRequest : FirestoreBaseServiceRequest<RunAggregationQueryResponse>, IClientServiceRequest<RunAggregationQueryResponse>, IClientServiceRequest

Constructors

RunAggregationQueryRequest(IClientService, RunAggregationQueryRequest, string)

Constructs a new RunAggregationQuery request.

Declaration
public RunAggregationQueryRequest(IClientService service, RunAggregationQueryRequest body, string parent)
Parameters
Type Name Description
IClientService service
RunAggregationQueryRequest body
string parent

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Parent

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

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes RunAggregationQuery parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements