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-
(::Google::Cloud::Firestore::V1::TransactionOptions) — 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.
#new_transaction=
def new_transaction=(value) -> ::Google::Cloud::Firestore::V1::TransactionOptions-
value (::Google::Cloud::Firestore::V1::TransactionOptions) — 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.
-
(::Google::Cloud::Firestore::V1::TransactionOptions) — 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.
#parent
def parent() -> ::String-
(::String) — Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
#parent=
def parent=(value) -> ::String-
value (::String) — Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
-
(::String) — Required. The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
#read_time
def read_time() -> ::Google::Protobuf::Timestamp-
(::Google::Protobuf::Timestamp) —
Executes the query at the given timestamp.
Requires:
- Cannot be more than 270 seconds in the past.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp-
value (::Google::Protobuf::Timestamp) —
Executes the query at the given timestamp.
Requires:
- Cannot be more than 270 seconds in the past.
-
(::Google::Protobuf::Timestamp) —
Executes the query at the given timestamp.
Requires:
- Cannot be more than 270 seconds in the past.
#structured_aggregation_query
def structured_aggregation_query() -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery- (::Google::Cloud::Firestore::V1::StructuredAggregationQuery) — An aggregation query.
#structured_aggregation_query=
def structured_aggregation_query=(value) -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery- value (::Google::Cloud::Firestore::V1::StructuredAggregationQuery) — An aggregation query.
- (::Google::Cloud::Firestore::V1::StructuredAggregationQuery) — An aggregation query.
#transaction
def transaction() -> ::String-
(::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-
value (::String) — Run the aggregation within an already active transaction.
The value here is the opaque transaction ID to execute the query in.
-
(::String) — Run the aggregation within an already active transaction.
The value here is the opaque transaction ID to execute the query in.