Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::RunAggregationQueryRequest (v0.12.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::RunAggregationQueryRequest.

The request for Firestore.RunAggregationQuery.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#new_transaction

def new_transaction() -> ::Google::Cloud::Firestore::V1::TransactionOptions
Returns

#new_transaction=

def new_transaction=(value) -> ::Google::Cloud::Firestore::V1::TransactionOptions
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — 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

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — 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
Returns
  • (::String) — 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

#read_time

def read_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#read_time=

def read_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — 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.

Returns
  • (::Google::Protobuf::Timestamp) — 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.

#structured_aggregation_query

def structured_aggregation_query() -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery
Returns

#structured_aggregation_query=

def structured_aggregation_query=(value) -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery
Parameter
Returns

#transaction

def transaction() -> ::String
Returns
  • (::String) — Run the aggregation within an already active transaction.

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

#transaction=

def transaction=(value) -> ::String
Parameter
  • value (::String) — Run the aggregation within an already active transaction.

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

Returns
  • (::String) — Run the aggregation within an already active transaction.

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