google-cloud-firestore-v1 0.7.1 → 0.9.0

data/proto_docs/google/firestore/v1/firestore.rb

@@ -21,7 +21,8 @@ module Google
   module Cloud
     module Firestore
       module V1
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#get_document Firestore.GetDocument}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#get_document Firestore.GetDocument}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Document to get. In the format:
@@ -44,68 +45,93 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#list_documents Firestore.ListDocuments}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#list_documents Firestore.ListDocuments}.
         # @!attribute [rw] parent
         #   @return [::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`
         # @!attribute [rw] collection_id
         #   @return [::String]
-        #     Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`
-        #     or `messages`.
+        #     Optional. The collection ID, relative to `parent`, to list.
+        #
+        #     For example: `chatrooms` or `messages`.
+        #
+        #     This is optional, and when not provided, Firestore will list documents
+        #     from all collections under the provided `parent`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
-        #     The maximum number of documents to return.
+        #     Optional. The maximum number of documents to return in a single response.
+        #
+        #     Firestore may return fewer than this value.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     The `next_page_token` value returned from a previous List request, if any.
+        #     Optional. A page token, received from a previous `ListDocuments` response.
+        #
+        #     Provide this to retrieve the subsequent page. When paginating, all other
+        #     parameters (with the exception of `page_size`) must match the values set
+        #     in the request that generated the page token.
         # @!attribute [rw] order_by
         #   @return [::String]
-        #     The order to sort results by. For example: `priority desc, name`.
+        #     Optional. The optional ordering of the documents to return.
+        #
+        #     For example: `priority desc, __name__ desc`.
+        #
+        #     This mirrors the {::Google::Cloud::Firestore::V1::StructuredQuery#order_by `ORDER BY`}
+        #     used in Firestore queries but in a string representation. When absent,
+        #     documents are ordered based on `__name__ ASC`.
         # @!attribute [rw] mask
         #   @return [::Google::Cloud::Firestore::V1::DocumentMask]
-        #     The fields to return. If not set, returns all fields.
+        #     Optional. The fields to return. If not set, returns all fields.
         #
         #     If a document has a field that is not present in this mask, that field
         #     will not be returned in the response.
         # @!attribute [rw] transaction
         #   @return [::String]
-        #     Reads documents in a transaction.
+        #     Perform the read as part of an already active transaction.
         # @!attribute [rw] read_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Reads documents as they were at the given time.
+        #     Perform the read at the provided time.
+        #
         #     This may not be older than 270 seconds.
         # @!attribute [rw] show_missing
         #   @return [::Boolean]
-        #     If the list should show missing documents. A missing document is a
-        #     document that does not exist but has sub-documents. These documents will
-        #     be returned with a key but will not have fields, {::Google::Cloud::Firestore::V1::Document#create_time Document.create_time},
-        #     or {::Google::Cloud::Firestore::V1::Document#update_time Document.update_time} set.
+        #     If the list should show missing documents.
+        #
+        #     A document is missing if it does not exist, but there are sub-documents
+        #     nested underneath it. When true, such missing documents will be returned
+        #     with a key but will not have fields,
+        #     {::Google::Cloud::Firestore::V1::Document#create_time `create_time`}, or
+        #     {::Google::Cloud::Firestore::V1::Document#update_time `update_time`} set.
         #
-        #     Requests with `show_missing` may not specify `where` or
-        #     `order_by`.
+        #     Requests with `show_missing` may not specify `where` or `order_by`.
         class ListDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Firestore::V1::Firestore::Client#list_documents Firestore.ListDocuments}.
+        # The response for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#list_documents Firestore.ListDocuments}.
         # @!attribute [rw] documents
         #   @return [::Array<::Google::Cloud::Firestore::V1::Document>]
         #     The Documents found.
         # @!attribute [rw] next_page_token
         #   @return [::String]
-        #     The next page token.
+        #     A token to retrieve the next page of documents.
+        #
+        #     If this field is omitted, there are no subsequent pages.
         class ListDocumentsResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#create_document Firestore.CreateDocument}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#create_document Firestore.CreateDocument}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource. For example:
@@ -113,7 +139,8 @@ module Google
         #     `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
         # @!attribute [rw] collection_id
         #   @return [::String]
-        #     Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
+        #     Required. The collection ID, relative to `parent`, to list. For example:
+        #     `chatrooms`.
         # @!attribute [rw] document_id
         #   @return [::String]
         #     The client-assigned document ID to use for this document.
@@ -133,7 +160,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#update_document Firestore.UpdateDocument}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#update_document Firestore.UpdateDocument}.
         # @!attribute [rw] document
         #   @return [::Google::Cloud::Firestore::V1::Document]
         #     Required. The updated document.
@@ -162,7 +190,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#delete_document Firestore.DeleteDocument}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#delete_document Firestore.DeleteDocument}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Document to delete. In the format:
@@ -176,7 +205,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#batch_get_documents Firestore.BatchGetDocuments}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#batch_get_documents Firestore.BatchGetDocuments}.
         # @!attribute [rw] database
         #   @return [::String]
         #     Required. The database name. In the format:
@@ -211,7 +241,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The streamed response for {::Google::Cloud::Firestore::V1::Firestore::Client#batch_get_documents Firestore.BatchGetDocuments}.
+        # The streamed response for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#batch_get_documents Firestore.BatchGetDocuments}.
         # @!attribute [rw] found
         #   @return [::Google::Cloud::Firestore::V1::Document]
         #     A document that was requested.
@@ -223,7 +254,8 @@ module Google
         #   @return [::String]
         #     The transaction that was started as part of this request.
         #     Will only be set in the first response, and only if
-        #     {::Google::Cloud::Firestore::V1::BatchGetDocumentsRequest#new_transaction BatchGetDocumentsRequest.new_transaction} was set in the request.
+        #     {::Google::Cloud::Firestore::V1::BatchGetDocumentsRequest#new_transaction BatchGetDocumentsRequest.new_transaction}
+        #     was set in the request.
         # @!attribute [rw] read_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The time at which the document was read.
@@ -235,7 +267,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#begin_transaction Firestore.BeginTransaction}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#begin_transaction Firestore.BeginTransaction}.
         # @!attribute [rw] database
         #   @return [::String]
         #     Required. The database name. In the format:
@@ -249,7 +282,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Firestore::V1::Firestore::Client#begin_transaction Firestore.BeginTransaction}.
+        # The response for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#begin_transaction Firestore.BeginTransaction}.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     The transaction that was started.
@@ -337,13 +371,15 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Firestore::V1::Firestore::Client#run_query Firestore.RunQuery}.
+        # The response for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#run_query Firestore.RunQuery}.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     The transaction that was started as part of this request.
         #     Can only be set in the first response, and only if
-        #     {::Google::Cloud::Firestore::V1::RunQueryRequest#new_transaction RunQueryRequest.new_transaction} was set in the request.
-        #     If set, no other fields will be set in this response.
+        #     {::Google::Cloud::Firestore::V1::RunQueryRequest#new_transaction RunQueryRequest.new_transaction}
+        #     was set in the request. If set, no other fields will be set in this
+        #     response.
         # @!attribute [rw] document
         #   @return [::Google::Cloud::Firestore::V1::Document]
         #     A query result, not set when reporting partial progress.
@@ -369,7 +405,65 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#partition_query Firestore.PartitionQuery}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#run_aggregation_query Firestore.RunAggregationQuery}.
+        # @!attribute [rw] parent
+        #   @return [::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`
+        # @!attribute [rw] structured_aggregation_query
+        #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery]
+        #     An aggregation query.
+        # @!attribute [rw] transaction
+        #   @return [::String]
+        #     Run the aggregation within an already active transaction.
+        #
+        #     The value here is the opaque transaction ID to execute the query in.
+        # @!attribute [rw] new_transaction
+        #   @return [::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.
+        # @!attribute [rw] read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Executes the query at the given timestamp.
+        #
+        #     Requires:
+        #
+        #     * Cannot be more than 270 seconds in the past.
+        class RunAggregationQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#run_aggregation_query Firestore.RunAggregationQuery}.
+        # @!attribute [rw] result
+        #   @return [::Google::Cloud::Firestore::V1::AggregationResult]
+        #     A single aggregation result.
+        #
+        #     Not present when reporting partial progress.
+        # @!attribute [rw] transaction
+        #   @return [::String]
+        #     The transaction that was started as part of this request.
+        #
+        #     Only present on the first response when the request requested to start
+        #     a new transaction.
+        # @!attribute [rw] read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time at which the aggregate value is valid for.
+        class RunAggregationQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#partition_query Firestore.PartitionQuery}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource name. In the format:
@@ -425,7 +519,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Firestore::V1::Firestore::Client#partition_query Firestore.PartitionQuery}.
+        # The response for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#partition_query Firestore.PartitionQuery}.
         # @!attribute [rw] partitions
         #   @return [::Array<::Google::Cloud::Firestore::V1::Cursor>]
         #     Partition results.
@@ -488,9 +583,9 @@ module Google
         #     A stream token that was previously sent by the server.
         #
         #     The client should set this field to the token from the most recent
-        #     {::Google::Cloud::Firestore::V1::WriteResponse WriteResponse} it has received. This acknowledges that the client has
-        #     received responses up to this token. After sending this token, earlier
-        #     tokens may not be used anymore.
+        #     {::Google::Cloud::Firestore::V1::WriteResponse WriteResponse} it has received. This
+        #     acknowledges that the client has received responses up to this token. After
+        #     sending this token, earlier tokens may not be used anymore.
         #
         #     The server may close the stream if there are too many unacknowledged
         #     responses.
@@ -582,8 +677,8 @@ module Google
         #     A {::Google::Cloud::Firestore::V1::Document Document} has been deleted.
         # @!attribute [rw] document_remove
         #   @return [::Google::Cloud::Firestore::V1::DocumentRemove]
-        #     A {::Google::Cloud::Firestore::V1::Document Document} has been removed from a target (because it is no longer
-        #     relevant to that target).
+        #     A {::Google::Cloud::Firestore::V1::Document Document} has been removed from a target
+        #     (because it is no longer relevant to that target).
         # @!attribute [rw] filter
         #   @return [::Google::Cloud::Firestore::V1::ExistenceFilter]
         #     A filter to apply to the set of documents previously returned for the
@@ -605,7 +700,8 @@ module Google
         #     A target specified by a set of document names.
         # @!attribute [rw] resume_token
         #   @return [::String]
-        #     A resume token from a prior {::Google::Cloud::Firestore::V1::TargetChange TargetChange} for an identical target.
+        #     A resume token from a prior
+        #     {::Google::Cloud::Firestore::V1::TargetChange TargetChange} for an identical target.
         #
         #     Using a resume token with a different target is unsupported and may fail.
         # @!attribute [rw] read_time
@@ -720,7 +816,8 @@ module Google
           end
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#list_collection_ids Firestore.ListCollectionIds}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#list_collection_ids Firestore.ListCollectionIds}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent document. In the format:
@@ -743,7 +840,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response from {::Google::Cloud::Firestore::V1::Firestore::Client#list_collection_ids Firestore.ListCollectionIds}.
+        # The response from
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#list_collection_ids Firestore.ListCollectionIds}.
         # @!attribute [rw] collection_ids
         #   @return [::Array<::String>]
         #     The collection ids.
@@ -755,7 +853,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Firestore::V1::Firestore::Client#batch_write Firestore.BatchWrite}.
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#batch_write Firestore.BatchWrite}.
         # @!attribute [rw] database
         #   @return [::String]
         #     Required. The database name. In the format:
@@ -784,7 +883,8 @@ module Google
           end
         end
 
-        # The response from {::Google::Cloud::Firestore::V1::Firestore::Client#batch_write Firestore.BatchWrite}.
+        # The response from
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#batch_write Firestore.BatchWrite}.
         # @!attribute [rw] write_results
         #   @return [::Array<::Google::Cloud::Firestore::V1::WriteResult>]
         #     The result of applying the writes.

data/proto_docs/google/firestore/v1/query.rb

@@ -55,22 +55,67 @@ module Google
         #         `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
         # @!attribute [rw] start_at
         #   @return [::Google::Cloud::Firestore::V1::Cursor]
-        #     A starting point for the query results.
+        #     A potential prefix of a position in the result set to start the query at.
+        #
+        #     The ordering of the result set is based on the `ORDER BY` clause of the
+        #     original query.
+        #
+        #     ```
+        #     SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
+        #     ```
+        #
+        #     This query's results are ordered by `(b ASC, __name__ ASC)`.
+        #
+        #     Cursors can reference either the full ordering or a prefix of the location,
+        #     though it cannot reference more fields than what are in the provided
+        #     `ORDER BY`.
+        #
+        #     Continuing off the example above, attaching the following start cursors
+        #     will have varying impact:
+        #
+        #     - `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
+        #        b > 2 AND __name__ > /k/123`.
+        #     - `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
+        #
+        #     Unlike `OFFSET` which requires scanning over the first N results to skip,
+        #     a start cursor allows the query to begin at a logical position. This
+        #     position is not required to match an actual result, it will scan forward
+        #     from this position to find the next document.
+        #
+        #     Requires:
+        #
+        #     * The number of values cannot be greater than the number of fields
+        #       specified in the `ORDER BY` clause.
         # @!attribute [rw] end_at
         #   @return [::Google::Cloud::Firestore::V1::Cursor]
-        #     A end point for the query results.
+        #     A potential prefix of a position in the result set to end the query at.
+        #
+        #     This is similar to `START_AT` but with it controlling the end position
+        #     rather than the start position.
+        #
+        #     Requires:
+        #
+        #     * The number of values cannot be greater than the number of fields
+        #       specified in the `ORDER BY` clause.
         # @!attribute [rw] offset
         #   @return [::Integer]
-        #     The number of results to skip.
+        #     The number of documents to skip before returning the first result.
+        #
+        #     This applies after the constraints specified by the `WHERE`, `START AT`, &
+        #     `END AT` but before the `LIMIT` clause.
         #
-        #     Applies before limit, but after all other constraints. Must be >= 0 if
-        #     specified.
+        #     Requires:
+        #
+        #     * The value must be greater than or equal to zero if specified.
         # @!attribute [rw] limit
         #   @return [::Google::Protobuf::Int32Value]
         #     The maximum number of results to return.
         #
         #     Applies after all other constraints.
-        #     Must be >= 0 if specified.
+        #
+        #     Requires:
+        #
+        #     * The value must be greater than or equal to zero if specified.
         class StructuredQuery
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -127,6 +172,9 @@ module Google
 
               # Documents are required to satisfy all of the combined filters.
               AND = 1
+
+              # Documents are required to satisfy at least one of the combined filters.
+              OR = 2
             end
           end
 
@@ -272,9 +320,15 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # A reference to a field, such as `max(messages.time) as max_time`.
+          # A reference to a field in a document, ex: `stats.operations`.
           # @!attribute [rw] field_path
           #   @return [::String]
+          #     The relative path of the document being referenced.
+          #
+          #     Requires:
+          #
+          #     * Conform to {::Google::Cloud::Firestore::V1::Document#fields document field name}
+          #     limitations.
           class FieldReference
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -305,6 +359,98 @@ module Google
           end
         end
 
+        # Firestore query for running an aggregation over a
+        # {::Google::Cloud::Firestore::V1::StructuredQuery StructuredQuery}.
+        # @!attribute [rw] structured_query
+        #   @return [::Google::Cloud::Firestore::V1::StructuredQuery]
+        #     Nested structured query.
+        # @!attribute [rw] aggregations
+        #   @return [::Array<::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation>]
+        #     Optional. Series of aggregations to apply over the results of the
+        #     `structured_query`.
+        #
+        #     Requires:
+        #
+        #     * A minimum of one and maximum of five aggregations per query.
+        class StructuredAggregationQuery
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Defines a aggregation that produces a single result.
+          # @!attribute [rw] count
+          #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count]
+          #     Count aggregator.
+          # @!attribute [rw] alias
+          #   @return [::String]
+          #     Optional. Optional name of the field to store the result of the
+          #     aggregation into.
+          #
+          #     If not provided, Firestore will pick a default name following the format
+          #     `field_<incremental_id++>`. For example:
+          #
+          #     ```
+          #     AGGREGATE
+          #       COUNT_UP_TO(1) AS count_up_to_1,
+          #       COUNT_UP_TO(2),
+          #       COUNT_UP_TO(3) AS count_up_to_3,
+          #       COUNT_UP_TO(4)
+          #     OVER (
+          #       ...
+          #     );
+          #     ```
+          #
+          #     becomes:
+          #
+          #     ```
+          #     AGGREGATE
+          #       COUNT_UP_TO(1) AS count_up_to_1,
+          #       COUNT_UP_TO(2) AS field_1,
+          #       COUNT_UP_TO(3) AS count_up_to_3,
+          #       COUNT_UP_TO(4) AS field_2
+          #     OVER (
+          #       ...
+          #     );
+          #     ```
+          #
+          #     Requires:
+          #
+          #     * Must be unique across all aggregation aliases.
+          #     * Conform to {::Google::Cloud::Firestore::V1::Document#fields document field name}
+          #     limitations.
+          class Aggregation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Count of documents that match the query.
+            #
+            # The `COUNT(*)` aggregation function operates on the entire document
+            # so it does not require a field reference.
+            # @!attribute [rw] up_to
+            #   @return [::Google::Protobuf::Int64Value]
+            #     Optional. Optional constraint on the maximum number of documents to
+            #     count.
+            #
+            #     This provides a way to set an upper bound on the number of documents
+            #     to scan, limiting latency and cost.
+            #
+            #     Unspecified is interpreted as no bound.
+            #
+            #     High-Level Example:
+            #
+            #     ```
+            #     AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
+            #     ```
+            #
+            #     Requires:
+            #
+            #     * Must be greater than zero when present.
+            class Count
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
         # A position in a query result set.
         # @!attribute [rw] values
         #   @return [::Array<::Google::Cloud::Firestore::V1::Value>]

data/proto_docs/google/firestore/v1/write.rb

@@ -77,8 +77,9 @@ module Google
           # A transformation of a field of the document.
           # @!attribute [rw] field_path
           #   @return [::String]
-          #     The path of the field. See {::Google::Cloud::Firestore::V1::Document#fields Document.fields} for the field path syntax
-          #     reference.
+          #     The path of the field. See
+          #     {::Google::Cloud::Firestore::V1::Document#fields Document.fields} for the field path
+          #     syntax reference.
           # @!attribute [rw] set_to_server_value
           #   @return [::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform::ServerValue]
           #     Sets the field to the given server value.
@@ -175,8 +176,9 @@ module Google
         #     previous update_time.
         # @!attribute [rw] transform_results
         #   @return [::Array<::Google::Cloud::Firestore::V1::Value>]
-        #     The results of applying each {::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform DocumentTransform.FieldTransform}, in the
-        #     same order.
+        #     The results of applying each
+        #     {::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform DocumentTransform.FieldTransform},
+        #     in the same order.
         class WriteResult
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -184,11 +186,12 @@ module Google
 
         # A {::Google::Cloud::Firestore::V1::Document Document} has changed.
         #
-        # May be the result of multiple {::Google::Cloud::Firestore::V1::Write writes}, including deletes, that
-        # ultimately resulted in a new value for the {::Google::Cloud::Firestore::V1::Document Document}.
+        # May be the result of multiple {::Google::Cloud::Firestore::V1::Write writes}, including
+        # deletes, that ultimately resulted in a new value for the
+        # {::Google::Cloud::Firestore::V1::Document Document}.
         #
-        # Multiple {::Google::Cloud::Firestore::V1::DocumentChange DocumentChange} messages may be returned for the same logical
-        # change, if multiple targets are affected.
+        # Multiple {::Google::Cloud::Firestore::V1::DocumentChange DocumentChange} messages may be
+        # returned for the same logical change, if multiple targets are affected.
         # @!attribute [rw] document
         #   @return [::Google::Cloud::Firestore::V1::Document]
         #     The new state of the {::Google::Cloud::Firestore::V1::Document Document}.
@@ -207,14 +210,16 @@ module Google
 
         # A {::Google::Cloud::Firestore::V1::Document Document} has been deleted.
         #
-        # May be the result of multiple {::Google::Cloud::Firestore::V1::Write writes}, including updates, the
-        # last of which deleted the {::Google::Cloud::Firestore::V1::Document Document}.
+        # May be the result of multiple {::Google::Cloud::Firestore::V1::Write writes}, including
+        # updates, the last of which deleted the
+        # {::Google::Cloud::Firestore::V1::Document Document}.
         #
-        # Multiple {::Google::Cloud::Firestore::V1::DocumentDelete DocumentDelete} messages may be returned for the same logical
-        # delete, if multiple targets are affected.
+        # Multiple {::Google::Cloud::Firestore::V1::DocumentDelete DocumentDelete} messages may be
+        # returned for the same logical delete, if multiple targets are affected.
         # @!attribute [rw] document
         #   @return [::String]
-        #     The resource name of the {::Google::Cloud::Firestore::V1::Document Document} that was deleted.
+        #     The resource name of the {::Google::Cloud::Firestore::V1::Document Document} that was
+        #     deleted.
         # @!attribute [rw] removed_target_ids
         #   @return [::Array<::Integer>]
         #     A set of target IDs for targets that previously matched this entity.
@@ -228,17 +233,20 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A {::Google::Cloud::Firestore::V1::Document Document} has been removed from the view of the targets.
+        # A {::Google::Cloud::Firestore::V1::Document Document} has been removed from the view of
+        # the targets.
         #
         # Sent if the document is no longer relevant to a target and is out of view.
         # Can be sent instead of a DocumentDelete or a DocumentChange if the server
         # can not send the new value of the document.
         #
-        # Multiple {::Google::Cloud::Firestore::V1::DocumentRemove DocumentRemove} messages may be returned for the same logical
-        # write or delete, if multiple targets are affected.
+        # Multiple {::Google::Cloud::Firestore::V1::DocumentRemove DocumentRemove} messages may be
+        # returned for the same logical write or delete, if multiple targets are
+        # affected.
         # @!attribute [rw] document
         #   @return [::String]
-        #     The resource name of the {::Google::Cloud::Firestore::V1::Document Document} that has gone out of view.
+        #     The resource name of the {::Google::Cloud::Firestore::V1::Document Document} that has
+        #     gone out of view.
         # @!attribute [rw] removed_target_ids
         #   @return [::Array<::Integer>]
         #     A set of target IDs for targets that previously matched this document.
@@ -258,7 +266,8 @@ module Google
         #     The target ID to which this filter applies.
         # @!attribute [rw] count
         #   @return [::Integer]
-        #     The total count of documents that match {::Google::Cloud::Firestore::V1::ExistenceFilter#target_id target_id}.
+        #     The total count of documents that match
+        #     {::Google::Cloud::Firestore::V1::ExistenceFilter#target_id target_id}.
         #
         #     If different from the count of documents in the client that match, the
         #     client must manually determine which documents no longer match the target.