google-apis-firestore_v1 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e14a35252c69959f958cf0370385d9b3c913c3aeb50335dc36b35393d4f0bd3d
-  data.tar.gz: b34f82ce0a3afb3761833531aec6ce30548abb9e66d5e78cca3f8455440193f6
+  metadata.gz: 56754b1259d90ecbc12eae2441505aaabf0aabbddc39c7cbd8ecb1d2c7851e41
+  data.tar.gz: e87dffa8f484e736ae95702a9d9704e5feb66f82ef4bd173474d30986e101b12
 SHA512:
-  metadata.gz: ccf9e5ebde5745b2ac9f3abf4b45f99d4d978b12938990c1c59cbb1e6a400fc32e44d3a54a0202905b732dfc9b34a037cc01d2b16fee653e1eea804d428c06ea
-  data.tar.gz: 8b24fccb3dc3f14359c785e0151907fd2af945e0233c682f52a2b7b85778820c1decb9a0fa1e471e6aa4b9a403213c0d86f47a23692c25497c30808c32a94617
+  metadata.gz: 7a55df4a172bf30a5924ce4c277f640ae39bf5b075e67b48f1e7291d1fec3c297df1886e1c014274e90c3b0863508abd851d46fcfb95bccf0a5a2449126747e6
+  data.tar.gz: 2d0c4b0f9f1715769f528db02013ac2a50ee49f9557f135331f0d46c9abc3e41d19a6bbc480cc00f43a97ecfa1091bc529068f04e76d3ff4e932c0f721b5fe20

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-firestore_v1
 
+### v0.28.0 (2022-09-28)
+
+* Regenerated from discovery document revision 20220915
+
 ### v0.27.0 (2022-09-21)
 
 * Regenerated using generator version 0.10.0

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

@@ -22,6 +22,62 @@ module Google
   module Apis
     module FirestoreV1
       
+      # Defines a aggregation that produces a single result.
+      class Aggregation
+        include Google::Apis::Core::Hashable
+      
+        # 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_`. 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
+        # 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::FirestoreV1::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::FirestoreV1::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
@@ -334,6 +390,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. 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.
+        # 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
@@ -2185,6 +2265,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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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
@@ -2317,6 +2472,33 @@ 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 over the results of the `
+        # structured_query`. Requires: * A minimum of one and maximum of five
+        # aggregations per query.
+        # Corresponds to the JSON property `aggregations`
+        # @return [Array<Google::Apis::FirestoreV1::Aggregation>]
+        attr_accessor :aggregations
+      
+        # A Firestore query.
+        # Corresponds to the JSON property `structuredQuery`
+        # @return [Google::Apis::FirestoreV1::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_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirestoreV1
       # Version of the google-apis-firestore_v1 gem
-      GEM_VERSION = "0.27.0"
+      GEM_VERSION = "0.28.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.10.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220831"
+      REVISION = "20220915"
     end
   end
 end

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

@@ -22,6 +22,18 @@ module Google
   module Apis
     module FirestoreV1
       
+      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
       
@@ -424,6 +442,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
       
@@ -442,6 +472,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
       
@@ -502,6 +538,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::FirestoreV1::Count, decorator: Google::Apis::FirestoreV1::Count::Representation
+      
+        end
+      end
+      
+      class AggregationResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :aggregate_fields, as: 'aggregateFields', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
+      
+        end
+      end
+      
       class ArrayValue
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -603,6 +656,13 @@ module Google
         end
       end
       
+      class Count
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :up_to, :numeric_string => true, as: 'upTo'
+        end
+      end
+      
       class Cursor
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1136,6 +1196,28 @@ module Google
         end
       end
       
+      class RunAggregationQueryRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
+      
+          property :read_time, as: 'readTime'
+          property :structured_aggregation_query, as: 'structuredAggregationQuery', class: Google::Apis::FirestoreV1::StructuredAggregationQuery, decorator: Google::Apis::FirestoreV1::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::FirestoreV1::AggregationResult, decorator: Google::Apis::FirestoreV1::AggregationResult::Representation
+      
+          property :transaction, :base64 => true, as: 'transaction'
+        end
+      end
+      
       class RunQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1169,6 +1251,16 @@ module Google
         end
       end
       
+      class StructuredAggregationQuery
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :aggregations, as: 'aggregations', class: Google::Apis::FirestoreV1::Aggregation, decorator: Google::Apis::FirestoreV1::Aggregation::Representation
+      
+          property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1::StructuredQuery, decorator: Google::Apis::FirestoreV1::StructuredQuery::Representation
+      
+        end
+      end
+      
       class StructuredQuery
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -1134,6 +1134,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::FirestoreV1::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::FirestoreV1::RunAggregationQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1::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, 'v1/{+parent}:runAggregationQuery', options)
+          command.request_representation = Google::Apis::FirestoreV1::RunAggregationQueryRequest::Representation
+          command.request_object = run_aggregation_query_request_object
+          command.response_representation = Google::Apis::FirestoreV1::RunAggregationQueryResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1::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_v1
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-10-03 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_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.27.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.28.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []