google-apis-firestore_v1beta1 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4883f7b025b8f6621073dabf1df6ec289c714836323b821b94d5e62e55a1b887
-  data.tar.gz: 38a7239b4b5113d51be7e713139e79e4d01b052a9a6eb5cfd53e4ec7f6c7b8f0
+  metadata.gz: b4d68fd45f0a34837336b1cde95add12b38129d2689d37e4333a18353a7658fa
+  data.tar.gz: 7a32f14bc19c4c228e29764ed65fbbde12ac0477de3281b964054c8e7f7a26ad
 SHA512:
-  metadata.gz: 69ab6e3f5120b1be23b683506ee12b5a8370852103fce63c46439a9cd2ed0160ef85a36653423dbbff6c6ef514338a968b708e8c8938cd46b3f05cdbee3a3f4e
-  data.tar.gz: acf076581cd85e2b13318abb65a21c07c6db82ac170f5954bd6b5103755a323277cf6e84303d0b9c8a40ebba7c93b40c8cd9121864e2ec654d1fb4929ffad43e
+  metadata.gz: a5bf55367115f6aece8b1777fc5aa5b41ac409696b079c7d93a0e2545d0ce8a5263220068f6314dddae3cbd1e5caf26c00fe17298a544915ece2a95f9f98c045
+  data.tar.gz: 9235cacce28e4a66a390909231f39d303ac60d6fb6c560beb6ddde90946c0dc36b68b25d17e87514d3089c6354310b7cf251846f422d3650e7b7b8357f098a1a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-firestore_v1beta1
 
+### v0.14.0 (2022-04-09)
+
+* Regenerated from discovery document revision 20220402
+
 ### v0.13.0 (2022-03-30)
 
 * Regenerated from discovery document revision 20220319

data/lib/google/apis/firestore_v1beta1/classes.rb

@@ -22,6 +22,57 @@ module Google
   module Apis
     module FirestoreV1beta1
       
+      # Defines a aggregation that produces a single result.
+      class Aggregation
+        include Google::Apis::Core::Hashable
+      
+        # Required. The name of the field to store the result of the aggregation into.
+        # Requires: * Must be present. * Must be unique across all aggregation aliases. *
+        # Conform to existing document field name limitations.
+        # Corresponds to the JSON property `alias`
+        # @return [String]
+        attr_accessor :alias
+      
+        # Count of documents that match the query. The `COUNT(*)` aggregation function
+        # operates on the entire document so it does not require a field reference.
+        # Corresponds to the JSON property `count`
+        # @return [Google::Apis::FirestoreV1beta1::Count]
+        attr_accessor :count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @alias = args[:alias] if args.key?(:alias)
+          @count = args[:count] if args.key?(:count)
+        end
+      end
+      
+      # The result of a single bucket from a Firestore aggregation query. The keys of `
+      # aggregate_fields` are the same for all results in an aggregation query, unlike
+      # document queries which can have different fields present for each result.
+      class AggregationResult
+        include Google::Apis::Core::Hashable
+      
+        # The result of the aggregation functions, ex: `COUNT(*) AS total_docs`. The key
+        # is the alias assigned to the aggregation function on input and the size of
+        # this map equals the number of aggregation functions in the query.
+        # Corresponds to the JSON property `aggregateFields`
+        # @return [Hash<String,Google::Apis::FirestoreV1beta1::Value>]
+        attr_accessor :aggregate_fields
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregate_fields = args[:aggregate_fields] if args.key?(:aggregate_fields)
+        end
+      end
+      
       # An array value.
       class ArrayValue
         include Google::Apis::Core::Hashable
@@ -313,7 +364,7 @@ module Google
       class CompositeFilter
         include Google::Apis::Core::Hashable
       
-        # The list of filters to combine. Must contain at least one filter.
+        # The list of filters to combine. Requires: * At least one filter is present.
         # Corresponds to the JSON property `filters`
         # @return [Array<Google::Apis::FirestoreV1beta1::Filter>]
         attr_accessor :filters
@@ -334,6 +385,30 @@ module Google
         end
       end
       
+      # Count of documents that match the query. The `COUNT(*)` aggregation function
+      # operates on the entire document so it does not require a field reference.
+      class Count
+        include Google::Apis::Core::Hashable
+      
+        # 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. High-Level Example: ``` SELECT COUNT_UP_TO(1000)
+        # FROM ( SELECT * FROM k ); ``` Requires: * Must be greater than zero when
+        # present.
+        # Corresponds to the JSON property `upTo`
+        # @return [Fixnum]
+        attr_accessor :up_to
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @up_to = args[:up_to] if args.key?(:up_to)
+        end
+      end
+      
       # A position in a query result set.
       class Cursor
         include Google::Apis::Core::Hashable
@@ -1699,6 +1774,81 @@ module Google
         end
       end
       
+      # The request for Firestore.RunAggregationQuery.
+      class RunAggregationQueryRequest
+        include Google::Apis::Core::Hashable
+      
+        # Options for creating a new transaction.
+        # Corresponds to the JSON property `newTransaction`
+        # @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
+        attr_accessor :new_transaction
+      
+        # Executes the query at the given timestamp. Requires: * Cannot be more than 270
+        # seconds in the past.
+        # Corresponds to the JSON property `readTime`
+        # @return [String]
+        attr_accessor :read_time
+      
+        # Firestore query for running an aggregation over a StructuredQuery.
+        # Corresponds to the JSON property `structuredAggregationQuery`
+        # @return [Google::Apis::FirestoreV1beta1::StructuredAggregationQuery]
+        attr_accessor :structured_aggregation_query
+      
+        # Run the aggregation within an already active transaction. The value here is
+        # the opaque transaction ID to execute the query in.
+        # Corresponds to the JSON property `transaction`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :transaction
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
+          @read_time = args[:read_time] if args.key?(:read_time)
+          @structured_aggregation_query = args[:structured_aggregation_query] if args.key?(:structured_aggregation_query)
+          @transaction = args[:transaction] if args.key?(:transaction)
+        end
+      end
+      
+      # The response for Firestore.RunAggregationQuery.
+      class RunAggregationQueryResponse
+        include Google::Apis::Core::Hashable
+      
+        # The time at which the aggregate value is valid for.
+        # Corresponds to the JSON property `readTime`
+        # @return [String]
+        attr_accessor :read_time
+      
+        # The result of a single bucket from a Firestore aggregation query. The keys of `
+        # aggregate_fields` are the same for all results in an aggregation query, unlike
+        # document queries which can have different fields present for each result.
+        # Corresponds to the JSON property `result`
+        # @return [Google::Apis::FirestoreV1beta1::AggregationResult]
+        attr_accessor :result
+      
+        # 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.
+        # Corresponds to the JSON property `transaction`
+        # NOTE: Values are automatically base64 encoded/decoded in the client library.
+        # @return [String]
+        attr_accessor :transaction
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @read_time = args[:read_time] if args.key?(:read_time)
+          @result = args[:result] if args.key?(:result)
+          @transaction = args[:transaction] if args.key?(:transaction)
+        end
+      end
+      
       # The request for Firestore.RunQuery.
       class RunQueryRequest
         include Google::Apis::Core::Hashable
@@ -1748,13 +1898,6 @@ module Google
         # @return [Google::Apis::FirestoreV1beta1::Document]
         attr_accessor :document
       
-        # If present, Firestore has completely finished the request and no more
-        # documents will be returned.
-        # Corresponds to the JSON property `done`
-        # @return [Boolean]
-        attr_accessor :done
-        alias_method :done?, :done
-      
         # The time at which the document was read. This may be monotonically increasing;
         # in this case, the previous documents in the result stream are guaranteed not
         # to have changed between their `read_time` and this one. If the query returns
@@ -1785,7 +1928,6 @@ module Google
         # Update properties of this object
         def update!(**args)
           @document = args[:document] if args.key?(:document)
-          @done = args[:done] if args.key?(:done)
           @read_time = args[:read_time] if args.key?(:read_time)
           @skipped_results = args[:skipped_results] if args.key?(:skipped_results)
           @transaction = args[:transaction] if args.key?(:transaction)
@@ -1831,6 +1973,31 @@ module Google
         end
       end
       
+      # Firestore query for running an aggregation over a StructuredQuery.
+      class StructuredAggregationQuery
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Series of aggregations to apply on top of the `structured_query`.
+        # Corresponds to the JSON property `aggregations`
+        # @return [Array<Google::Apis::FirestoreV1beta1::Aggregation>]
+        attr_accessor :aggregations
+      
+        # A Firestore query.
+        # Corresponds to the JSON property `structuredQuery`
+        # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
+        attr_accessor :structured_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregations = args[:aggregations] if args.key?(:aggregations)
+          @structured_query = args[:structured_query] if args.key?(:structured_query)
+        end
+      end
+      
       # A Firestore query.
       class StructuredQuery
         include Google::Apis::Core::Hashable

data/lib/google/apis/firestore_v1beta1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirestoreV1beta1
       # Version of the google-apis-firestore_v1beta1 gem
-      GEM_VERSION = "0.13.0"
+      GEM_VERSION = "0.14.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220319"
+      REVISION = "20220402"
     end
   end
 end

data/lib/google/apis/firestore_v1beta1/representations.rb

@@ -22,6 +22,18 @@ module Google
   module Apis
     module FirestoreV1beta1
       
+      class Aggregation
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AggregationResult
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ArrayValue
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -88,6 +100,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Count
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Cursor
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -346,6 +364,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RunAggregationQueryRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class RunAggregationQueryResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class RunQueryRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -364,6 +394,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class StructuredAggregationQuery
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class StructuredQuery
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -424,6 +460,23 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Aggregation
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :alias, as: 'alias'
+          property :count, as: 'count', class: Google::Apis::FirestoreV1beta1::Count, decorator: Google::Apis::FirestoreV1beta1::Count::Representation
+      
+        end
+      end
+      
+      class AggregationResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :aggregate_fields, as: 'aggregateFields', class: Google::Apis::FirestoreV1beta1::Value, decorator: Google::Apis::FirestoreV1beta1::Value::Representation
+      
+        end
+      end
+      
       class ArrayValue
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -525,6 +578,13 @@ module Google
         end
       end
       
+      class Count
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :up_to, as: 'upTo'
+        end
+      end
+      
       class Cursor
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -928,6 +988,28 @@ module Google
         end
       end
       
+      class RunAggregationQueryRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
+      
+          property :read_time, as: 'readTime'
+          property :structured_aggregation_query, as: 'structuredAggregationQuery', class: Google::Apis::FirestoreV1beta1::StructuredAggregationQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredAggregationQuery::Representation
+      
+          property :transaction, :base64 => true, as: 'transaction'
+        end
+      end
+      
+      class RunAggregationQueryResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :read_time, as: 'readTime'
+          property :result, as: 'result', class: Google::Apis::FirestoreV1beta1::AggregationResult, decorator: Google::Apis::FirestoreV1beta1::AggregationResult::Representation
+      
+          property :transaction, :base64 => true, as: 'transaction'
+        end
+      end
+      
       class RunQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -945,7 +1027,6 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :document, as: 'document', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
       
-          property :done, as: 'done'
           property :read_time, as: 'readTime'
           property :skipped_results, as: 'skippedResults'
           property :transaction, :base64 => true, as: 'transaction'
@@ -961,6 +1042,16 @@ module Google
         end
       end
       
+      class StructuredAggregationQuery
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :aggregations, as: 'aggregations', class: Google::Apis::FirestoreV1beta1::Aggregation, decorator: Google::Apis::FirestoreV1beta1::Aggregation::Representation
+      
+          property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
+      
+        end
+      end
+      
       class StructuredQuery
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/firestore_v1beta1/service.rb

@@ -717,6 +717,47 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # 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 ); ```
+        # @param [String] 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`
+        # @param [Google::Apis::FirestoreV1beta1::RunAggregationQueryRequest] run_aggregation_query_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirestoreV1beta1::RunAggregationQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1beta1::RunAggregationQueryResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def run_document_aggregation_query(parent, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+parent}:runAggregationQuery', options)
+          command.request_representation = Google::Apis::FirestoreV1beta1::RunAggregationQueryRequest::Representation
+          command.request_object = run_aggregation_query_request_object
+          command.response_representation = Google::Apis::FirestoreV1beta1::RunAggregationQueryResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1beta1::RunAggregationQueryResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Runs a query.
         # @param [String] parent
         #   Required. The parent resource name. In the format: `projects/`project_id`/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.13.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.14.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
 post_install_message: 
 rdoc_options: []