google-apis-firestore_v1beta1 0.37.0 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76ecc92adc540edf809c95cb52b8fa816e7eba966b6c2ae2a6a493dadee1028a
-  data.tar.gz: 6d6fd2dc62af611b3c479f4da47eb3a69d89b45a0b7a34b4d8da1c5a594439c6
+  metadata.gz: 0e9525f9b0c306b65b524f4cb6300a292e1eda4bc54c869d1244a03b06aeb2b2
+  data.tar.gz: 5c9b35cc8aaf6f2591f7153112489ad2452d532f656010f99f4bbbf3e9eda3d0
 SHA512:
-  metadata.gz: 530fe9413e19bf5c4c0240da5a0162da199d5a01adcf1f11329d82b64af10b6ddf599e40fe5a3e6af4aa64529e986406b53deab720a777abe722974c044e2b83
-  data.tar.gz: 586eb2f58c592f8ddc60ce32ca98c2fb1760801743c9eb80b9f18e40c92a4f73054eb1ff1f637e4e5e9c2d47a477e8253a612f9c9a2d636cdc3d730e5e4dced3
+  metadata.gz: 4fc374212db090399b4c524bf3cd0f30da6c7f88e0a0d8bf19c40c01593c09274006fb5785f77e68893698e0ffccfa14629e512f36a38f510b6ce1d6e2d5d95b
+  data.tar.gz: 10076803fa1f90623e58b48723a968dba313e2c5aa6e49202dad12d61a0b7fcb2421abe6f53199a94ed2199545215ca181ea34cb6c2a12faf3b14af6dd59712b

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1beta1
 
+### v0.39.0 (2024-03-24)
+
+* Regenerated from discovery document revision 20240317
+
+### v0.38.0 (2024-02-24)
+
+* Regenerated from discovery document revision 20240215
+* Regenerated using generator version 0.14.0
+
 ### v0.37.0 (2024-02-18)
 
 * Regenerated from discovery document revision 20240208

data/OVERVIEW.md

@@ -83,9 +83,9 @@ The [product documentation](https://cloud.google.com/firestore) may provide guid
 
 ## Supported Ruby versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.7+.
 
-Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
+Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
 
 ## License
 

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

@@ -826,6 +826,48 @@ module Google
         end
       end
       
+      # Execution statistics for the query.
+      class ExecutionStats
+        include Google::Apis::Core::Hashable
+      
+        # Debugging statistics from the execution of the query. Note that the debugging
+        # stats are subject to change as Firestore evolves. It could include: ` "
+        # indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details"
+        # : ` "documents_billable": "20", "index_entries_billable": "1000", "
+        # min_query_cost": "0" ` `
+        # Corresponds to the JSON property `debugStats`
+        # @return [Hash<String,Object>]
+        attr_accessor :debug_stats
+      
+        # Total time to execute the query in the backend.
+        # Corresponds to the JSON property `executionDuration`
+        # @return [String]
+        attr_accessor :execution_duration
+      
+        # Total billable read operations.
+        # Corresponds to the JSON property `readOperations`
+        # @return [Fixnum]
+        attr_accessor :read_operations
+      
+        # Total number of results returned, including documents, projections,
+        # aggregation results, keys.
+        # Corresponds to the JSON property `resultsReturned`
+        # @return [Fixnum]
+        attr_accessor :results_returned
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @debug_stats = args[:debug_stats] if args.key?(:debug_stats)
+          @execution_duration = args[:execution_duration] if args.key?(:execution_duration)
+          @read_operations = args[:read_operations] if args.key?(:read_operations)
+          @results_returned = args[:results_returned] if args.key?(:results_returned)
+        end
+      end
+      
       # A digest of all the documents that match a given target.
       class ExistenceFilter
         include Google::Apis::Core::Hashable
@@ -869,6 +911,31 @@ module Google
         end
       end
       
+      # Explain metrics for the query.
+      class ExplainMetrics
+        include Google::Apis::Core::Hashable
+      
+        # Execution statistics for the query.
+        # Corresponds to the JSON property `executionStats`
+        # @return [Google::Apis::FirestoreV1beta1::ExecutionStats]
+        attr_accessor :execution_stats
+      
+        # Planning phase information for the query.
+        # Corresponds to the JSON property `planSummary`
+        # @return [Google::Apis::FirestoreV1beta1::PlanSummary]
+        attr_accessor :plan_summary
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @execution_stats = args[:execution_stats] if args.key?(:execution_stats)
+          @plan_summary = args[:plan_summary] if args.key?(:plan_summary)
+        end
+      end
+      
       # Explain options for the query.
       class ExplainOptions
         include Google::Apis::Core::Hashable
@@ -1926,6 +1993,27 @@ module Google
         end
       end
       
+      # Planning phase information for the query.
+      class PlanSummary
+        include Google::Apis::Core::Hashable
+      
+        # The indexes selected for the query. For example: [ `"query_scope": "Collection"
+        # , "properties": "(foo ASC, __name__ ASC)"`, `"query_scope": "Collection", "
+        # properties": "(bar ASC, __name__ ASC)"` ]
+        # Corresponds to the JSON property `indexesUsed`
+        # @return [Array<Hash<String,Object>>]
+        attr_accessor :indexes_used
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @indexes_used = args[:indexes_used] if args.key?(:indexes_used)
+        end
+      end
+      
       # A precondition on a document, used for conditional operations.
       class Precondition
         include Google::Apis::Core::Hashable
@@ -2118,6 +2206,11 @@ module Google
       class RunAggregationQueryResponse
         include Google::Apis::Core::Hashable
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::FirestoreV1beta1::ExplainMetrics]
+        attr_accessor :explain_metrics
+      
         # The time at which the aggregate result was computed. This is always
         # monotonically increasing; in this case, the previous AggregationResult in the
         # result stream are guaranteed not to have changed between their `read_time` and
@@ -2147,6 +2240,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @explain_metrics = args[:explain_metrics] if args.key?(:explain_metrics)
           @read_time = args[:read_time] if args.key?(:read_time)
           @result = args[:result] if args.key?(:result)
           @transaction = args[:transaction] if args.key?(:transaction)
@@ -2217,6 +2311,11 @@ module Google
         attr_accessor :done
         alias_method :done?, :done
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::FirestoreV1beta1::ExplainMetrics]
+        attr_accessor :explain_metrics
+      
         # 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
@@ -2248,6 +2347,7 @@ module Google
         def update!(**args)
           @document = args[:document] if args.key?(:document)
           @done = args[:done] if args.key?(:done)
+          @explain_metrics = args[:explain_metrics] if args.key?(:explain_metrics)
           @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)

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.37.0"
+      GEM_VERSION = "0.39.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.13.1"
+      GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240208"
+      REVISION = "20240317"
     end
   end
 end

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

@@ -178,12 +178,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ExecutionStats
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ExistenceFilter
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ExplainMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ExplainOptions
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -376,6 +388,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PlanSummary
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Precondition
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -745,6 +763,16 @@ module Google
         end
       end
       
+      class ExecutionStats
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :debug_stats, as: 'debugStats'
+          property :execution_duration, as: 'executionDuration'
+          property :read_operations, :numeric_string => true, as: 'readOperations'
+          property :results_returned, :numeric_string => true, as: 'resultsReturned'
+        end
+      end
+      
       class ExistenceFilter
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -755,6 +783,16 @@ module Google
         end
       end
       
+      class ExplainMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :execution_stats, as: 'executionStats', class: Google::Apis::FirestoreV1beta1::ExecutionStats, decorator: Google::Apis::FirestoreV1beta1::ExecutionStats::Representation
+      
+          property :plan_summary, as: 'planSummary', class: Google::Apis::FirestoreV1beta1::PlanSummary, decorator: Google::Apis::FirestoreV1beta1::PlanSummary::Representation
+      
+        end
+      end
+      
       class ExplainOptions
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1067,6 +1105,13 @@ module Google
         end
       end
       
+      class PlanSummary
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :indexes_used, as: 'indexesUsed'
+        end
+      end
+      
       class Precondition
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1130,6 +1175,8 @@ module Google
       class RunAggregationQueryResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::FirestoreV1beta1::ExplainMetrics, decorator: Google::Apis::FirestoreV1beta1::ExplainMetrics::Representation
+      
           property :read_time, as: 'readTime'
           property :result, as: 'result', class: Google::Apis::FirestoreV1beta1::AggregationResult, decorator: Google::Apis::FirestoreV1beta1::AggregationResult::Representation
       
@@ -1157,6 +1204,8 @@ module Google
           property :document, as: 'document', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
       
           property :done, as: 'done'
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::FirestoreV1beta1::ExplainMetrics, decorator: Google::Apis::FirestoreV1beta1::ExplainMetrics::Representation
+      
           property :read_time, as: 'readTime'
           property :skipped_results, as: 'skippedResults'
           property :transaction, :base64 => true, as: 'transaction'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.39.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-18 00:00:00.000000000 Z
+date: 2024-03-24 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.12.0
+        version: 0.14.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.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_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.37.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.39.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
 post_install_message: 
 rdoc_options: []
@@ -68,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Firestore API V1beta1