google-apis-firestore_v1 0.56.0 → 0.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b964752b52059e66f4e588e533818d10fe5530cc48d55a79980539d29e20da
-  data.tar.gz: 0e79fc8682b7c4a908d9593c045c61fb592223f999b6a53da17ec1861422c836
+  metadata.gz: cf35ac5ab5216d3a9791cdee286cc9ba9827680bb17a65226ab8b87b9954ae9a
+  data.tar.gz: 04e49bd9e54449bb102f89ba88c361a5db38f2bb3462d1f8a1d2159cb91f6437
 SHA512:
-  metadata.gz: e369f48af82fba29085b5fcc05c8cf5e142096f64005248bc103f76c8ffc4050cbcc795680dd813a795007f49ca5ec2212ce694598c4d0fdae102da363eec2d7
-  data.tar.gz: 75b8e6dde795acc0f3ccfb74ad27196cb5e40918c3857fd8c990c882ce5ed2eaa47afbb83f4a262205911c44e1ad3ed13daa4dbe2e00b244f7bbfc0f3bdbd185
+  metadata.gz: b131fbd29589441e56abc870f53e84838a5e9a1baf999d55900db01d840c3ff68a97f656b73e92c8702aeafa46181fc5e6cf14e81e67fb851db0011ca8f766f8
+  data.tar.gz: 648f7ee4698de14c42b9d1fbd6dd62d8224b9a05f30a930dec2821bad0c9e9bff4a48d6b4c81931f04ccc18c746b215fe5a9d7aa06f52d806934ca379e3a9cad

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-firestore_v1
 
+### v0.57.0 (2024-01-23)
+
+* Regenerated from discovery document revision 20240117
+* Regenerated using generator version 0.13.0
+
 ### v0.56.0 (2023-12-24)
 
 * Regenerated from discovery document revision 20231214

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

@@ -588,7 +588,21 @@ module Google
         # @return [String]
         attr_accessor :create_time
       
-        # 
+        # The document's fields. The map keys represent field names. Field names
+        # matching the regular expression `__.*__` are reserved. Reserved field names
+        # are forbidden except in certain documented contexts. The field names,
+        # represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field
+        # paths may be used in other contexts to refer to structured fields defined here.
+        # For `map_value`, the field path is represented by a dot-delimited (`.`)
+        # string of segments. Each segment is either a simple field name (defined below)
+        # or a quoted field name. For example, the structured field `"foo" : ` map_value:
+        # ` "x&y" : ` string_value: "hello" ```` would be represented by the field path
+        # `` foo.`x&y` ``. A simple field name contains only characters `a` to `z`, `A`
+        # to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `
+        # foo_bar_17`. A quoted field name starts and ends with `` ` `` and may contain
+        # any character. Some characters, including `` ` ``, must be escaped using a `\`.
+        # For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents ``
+        # bak`tik ``.
         # Corresponds to the JSON property `fields`
         # @return [Hash<String,Google::Apis::FirestoreV1::Value>]
         attr_accessor :fields
@@ -2758,7 +2772,8 @@ module Google
         # @return [String]
         attr_accessor :read_time
       
-        # A Firestore query.
+        # A Firestore query. The query stages are executed in the following order: 1.
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1::StructuredQuery]
         attr_accessor :structured_query
@@ -2861,6 +2876,27 @@ module Google
         end
       end
       
+      # Plan for the query.
+      class QueryPlan
+        include Google::Apis::Core::Hashable
+      
+        # Planning phase information for the query. It will include: ` "indexes_used": [
+        # `"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"`, `"
+        # query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"` ] `
+        # Corresponds to the JSON property `planInfo`
+        # @return [Hash<String,Object>]
+        attr_accessor :plan_info
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @plan_info = args[:plan_info] if args.key?(:plan_info)
+        end
+      end
+      
       # A target specified by a query.
       class QueryTarget
         include Google::Apis::Core::Hashable
@@ -2874,7 +2910,8 @@ module Google
         # @return [String]
         attr_accessor :parent
       
-        # A Firestore query.
+        # A Firestore query. The query stages are executed in the following order: 1.
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1::StructuredQuery]
         attr_accessor :structured_query
@@ -2933,6 +2970,35 @@ module Google
         end
       end
       
+      # Planning and execution statistics for the query.
+      class ResultSetStats
+        include Google::Apis::Core::Hashable
+      
+        # Plan for the query.
+        # Corresponds to the JSON property `queryPlan`
+        # @return [Google::Apis::FirestoreV1::QueryPlan]
+        attr_accessor :query_plan
+      
+        # Aggregated statistics from the execution of the query. This will only be
+        # present when the request specifies `PROFILE` mode. For example, a query will
+        # return the statistics including: ` "results_returned": "20", "
+        # documents_scanned": "20", "indexes_entries_scanned": "10050", "
+        # total_execution_time": "100.7 msecs" `
+        # Corresponds to the JSON property `queryStats`
+        # @return [Hash<String,Object>]
+        attr_accessor :query_stats
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @query_plan = args[:query_plan] if args.key?(:query_plan)
+          @query_stats = args[:query_stats] if args.key?(:query_stats)
+        end
+      end
+      
       # The request for Firestore.Rollback.
       class RollbackRequest
         include Google::Apis::Core::Hashable
@@ -2957,6 +3023,13 @@ module Google
       class RunAggregationQueryRequest
         include Google::Apis::Core::Hashable
       
+        # Optional. The mode in which the query request is processed. This field is
+        # optional, and when not provided, it defaults to `NORMAL` mode where no
+        # additional statistics will be returned with the query results.
+        # Corresponds to the JSON property `mode`
+        # @return [String]
+        attr_accessor :mode
+      
         # Options for creating a new transaction.
         # Corresponds to the JSON property `newTransaction`
         # @return [Google::Apis::FirestoreV1::TransactionOptions]
@@ -2987,6 +3060,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @mode = args[:mode] if args.key?(:mode)
           @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)
@@ -3014,6 +3088,11 @@ module Google
         # @return [Google::Apis::FirestoreV1::AggregationResult]
         attr_accessor :result
       
+        # Planning and execution statistics for the query.
+        # Corresponds to the JSON property `stats`
+        # @return [Google::Apis::FirestoreV1::ResultSetStats]
+        attr_accessor :stats
+      
         # 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`
@@ -3029,6 +3108,7 @@ module Google
         def update!(**args)
           @read_time = args[:read_time] if args.key?(:read_time)
           @result = args[:result] if args.key?(:result)
+          @stats = args[:stats] if args.key?(:stats)
           @transaction = args[:transaction] if args.key?(:transaction)
         end
       end
@@ -3037,6 +3117,13 @@ module Google
       class RunQueryRequest
         include Google::Apis::Core::Hashable
       
+        # Optional. The mode in which the query request is processed. This field is
+        # optional, and when not provided, it defaults to `NORMAL` mode where no
+        # additional statistics will be returned with the query results.
+        # Corresponds to the JSON property `mode`
+        # @return [String]
+        attr_accessor :mode
+      
         # Options for creating a new transaction.
         # Corresponds to the JSON property `newTransaction`
         # @return [Google::Apis::FirestoreV1::TransactionOptions]
@@ -3049,7 +3136,8 @@ module Google
         # @return [String]
         attr_accessor :read_time
       
-        # A Firestore query.
+        # A Firestore query. The query stages are executed in the following order: 1.
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1::StructuredQuery]
         attr_accessor :structured_query
@@ -3067,6 +3155,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @mode = args[:mode] if args.key?(:mode)
           @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
           @read_time = args[:read_time] if args.key?(:read_time)
           @structured_query = args[:structured_query] if args.key?(:structured_query)
@@ -3105,6 +3194,11 @@ module Google
         # @return [Fixnum]
         attr_accessor :skipped_results
       
+        # Planning and execution statistics for the query.
+        # Corresponds to the JSON property `stats`
+        # @return [Google::Apis::FirestoreV1::ResultSetStats]
+        attr_accessor :stats
+      
         # The transaction that was started as part of this request. Can only be set in
         # the first response, and only if RunQueryRequest.new_transaction was set in the
         # request. If set, no other fields will be set in this response.
@@ -3123,6 +3217,7 @@ module Google
           @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)
+          @stats = args[:stats] if args.key?(:stats)
           @transaction = args[:transaction] if args.key?(:transaction)
         end
       end
@@ -3177,7 +3272,8 @@ module Google
         # @return [Array<Google::Apis::FirestoreV1::Aggregation>]
         attr_accessor :aggregations
       
-        # A Firestore query.
+        # A Firestore query. The query stages are executed in the following order: 1.
+        # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1::StructuredQuery]
         attr_accessor :structured_query
@@ -3193,7 +3289,8 @@ module Google
         end
       end
       
-      # A Firestore query.
+      # A Firestore query. The query stages are executed in the following order: 1.
+      # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit
       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.56.0"
+      GEM_VERSION = "0.57.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.12.0"
+      GENERATOR_VERSION = "0.13.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20231214"
+      REVISION = "20240117"
     end
   end
 end

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

@@ -520,6 +520,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class QueryPlan
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class QueryTarget
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -538,6 +544,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ResultSetStats
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class RollbackRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1447,6 +1459,13 @@ module Google
         end
       end
       
+      class QueryPlan
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :plan_info, as: 'planInfo'
+        end
+      end
+      
       class QueryTarget
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1470,6 +1489,15 @@ module Google
         end
       end
       
+      class ResultSetStats
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :query_plan, as: 'queryPlan', class: Google::Apis::FirestoreV1::QueryPlan, decorator: Google::Apis::FirestoreV1::QueryPlan::Representation
+      
+          hash :query_stats, as: 'queryStats'
+        end
+      end
+      
       class RollbackRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1480,6 +1508,7 @@ module Google
       class RunAggregationQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :mode, as: 'mode'
           property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
       
           property :read_time, as: 'readTime'
@@ -1495,6 +1524,8 @@ module Google
           property :read_time, as: 'readTime'
           property :result, as: 'result', class: Google::Apis::FirestoreV1::AggregationResult, decorator: Google::Apis::FirestoreV1::AggregationResult::Representation
       
+          property :stats, as: 'stats', class: Google::Apis::FirestoreV1::ResultSetStats, decorator: Google::Apis::FirestoreV1::ResultSetStats::Representation
+      
           property :transaction, :base64 => true, as: 'transaction'
         end
       end
@@ -1502,6 +1533,7 @@ module Google
       class RunQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :mode, as: 'mode'
           property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
       
           property :read_time, as: 'readTime'
@@ -1519,6 +1551,8 @@ module Google
           property :done, as: 'done'
           property :read_time, as: 'readTime'
           property :skipped_results, as: 'skippedResults'
+          property :stats, as: 'stats', class: Google::Apis::FirestoreV1::ResultSetStats, decorator: Google::Apis::FirestoreV1::ResultSetStats::Representation
+      
           property :transaction, :base64 => true, as: 'transaction'
         end
       end

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

@@ -33,6 +33,8 @@ module Google
       #
       # @see https://cloud.google.com/firestore
       class FirestoreService < Google::Apis::Core::BaseService
+        DEFAULT_ENDPOINT_TEMPLATE = "https://firestore.$UNIVERSE_DOMAIN$/"
+
         # @return [String]
         #  API key. Your API key identifies your project and provides you with API access,
         #  quota, and reports. Required unless you provide an OAuth 2.0 token.
@@ -44,7 +46,7 @@ module Google
         attr_accessor :quota_user
 
         def initialize
-          super('https://firestore.googleapis.com/', '',
+          super(DEFAULT_ENDPOINT_TEMPLATE, '',
                 client_name: 'google-apis-firestore_v1',
                 client_version: Google::Apis::FirestoreV1::GEM_VERSION)
           @batch_path = 'batch'
@@ -544,7 +546,7 @@ module Google
         # Lists the field configuration and metadata for this database. Currently,
         # FirestoreAdmin.ListFields only supports listing fields that have been
         # explicitly overridden. To issue this query, call FirestoreAdmin.ListFields
-        # with the filter set to `indexConfig.usesAncestorConfig:false or `ttlConfig:*`.
+        # with the filter set to `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`.
         # @param [String] parent
         #   Required. A parent name of the form `projects/`project_id`/databases/`
         #   database_id`/collectionGroups/`collection_id``

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.56.0
+  version: 0.57.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-24 00:00:00.000000000 Z
+date: 2024-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -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.56.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.57.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Firestore API V1