google-apis-firestore_v1 0.62.0 → 0.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b576326435612aed0848a1d3eadab517c30e04173bc1d6811057ec75401e2e85
-  data.tar.gz: a8876f209fff58c2d85bfec74978693c7a7b6324adaf1f8b8fe0f6629071dfcd
+  metadata.gz: 28a6c296849b8cb47ea74c00ea548841d79a639b0b86318252e2df480b1e7ea3
+  data.tar.gz: 9f229c8da59eb9e1fcaff2c221019516c6d94bd8b65a76ff7a325862cd82c954
 SHA512:
-  metadata.gz: a2ed773c6078cab1cfb82fbc020b9d08528d1ad28fa4ce4851f8d6f79bf3e383dcd6c7e2d595548630a2c2f764d6c100aa68a6b60fcf9a6c2be09c282ebc1be6
-  data.tar.gz: 516944531f1b9e707b74251b1a1f67bde4d4fd1dc7f66bc6c62eaf83cc635073888ad62c0251d47ed71a11b62eb1a7793ad03a48af64064f962a633b9a78e313
+  metadata.gz: ffaf940574d370de8039581022087fd0201416fb1ec4236f71405322a7755c87496bb9fbc0e665818edc9666e97d2e4a57842b86ef806f50201a5bea99c04b93
+  data.tar.gz: f5e4554d41e0acfbe5ebda0305ffa9831708b2ff0d13f5b1c59caa4460684e587637438356f2e03f265d5e2254554d8a00011064da9882b1f48e65e31bf52d7d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-firestore_v1
 
+### v0.64.0 (2024-03-31)
+
+* Regenerated from discovery document revision 20240324
+
+### v0.63.0 (2024-03-24)
+
+* Regenerated from discovery document revision 20240317
+
 ### v0.62.0 (2024-03-17)
 
 * Regenerated from discovery document revision 20240307

data/lib/google/apis/firestore_v1/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,54 @@ 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::FirestoreV1::ExecutionStats]
+        attr_accessor :execution_stats
+      
+        # Planning phase information for the query.
+        # Corresponds to the JSON property `planSummary`
+        # @return [Google::Apis::FirestoreV1::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
+      
+        # Optional. Whether to execute this query. When false (the default), the query
+        # will be planned, returning only metrics from the planning stages. When true,
+        # the query will be planned and executed, returning the full query results along
+        # with both planning and execution stage metrics.
+        # Corresponds to the JSON property `analyze`
+        # @return [Boolean]
+        attr_accessor :analyze
+        alias_method :analyze?, :analyze
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @analyze = args[:analyze] if args.key?(:analyze)
+        end
+      end
+      
       # A filter on a specific field.
       class FieldFilter
         include Google::Apis::Core::Hashable
@@ -1007,6 +1097,44 @@ module Google
         end
       end
       
+      # Nearest Neighbors search config.
+      class FindNearest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The Distance Measure to use, required.
+        # Corresponds to the JSON property `distanceMeasure`
+        # @return [String]
+        attr_accessor :distance_measure
+      
+        # Required. The number of nearest neighbors to return. Must be a positive
+        # integer of no more than 1000.
+        # Corresponds to the JSON property `limit`
+        # @return [Fixnum]
+        attr_accessor :limit
+      
+        # A message that can hold any of the supported value types.
+        # Corresponds to the JSON property `queryVector`
+        # @return [Google::Apis::FirestoreV1::Value]
+        attr_accessor :query_vector
+      
+        # A reference to a field in a document, ex: `stats.operations`.
+        # Corresponds to the JSON property `vectorField`
+        # @return [Google::Apis::FirestoreV1::FieldReference]
+        attr_accessor :vector_field
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @distance_measure = args[:distance_measure] if args.key?(:distance_measure)
+          @limit = args[:limit] if args.key?(:limit)
+          @query_vector = args[:query_vector] if args.key?(:query_vector)
+          @vector_field = args[:vector_field] if args.key?(:vector_field)
+        end
+      end
+      
       # A Backup of a Cloud Firestore Database. The backup contains all documents and
       # index configurations for the given database at a specific point in time.
       class GoogleFirestoreAdminV1Backup
@@ -1079,7 +1207,7 @@ module Google
         # @return [String]
         attr_accessor :create_time
       
-        # Represent a recurring schedule that runs at a specific time every day. The
+        # Represents a recurring schedule that runs at a specific time every day. The
         # time zone is UTC.
         # Corresponds to the JSON property `dailyRecurrence`
         # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DailyRecurrence]
@@ -1175,7 +1303,7 @@ module Google
         end
       end
       
-      # Represent a recurring schedule that runs at a specific time every day. The
+      # Represents a recurring schedule that runs at a specific time every day. The
       # time zone is UTC.
       class GoogleFirestoreAdminV1DailyRecurrence
         include Google::Apis::Core::Hashable
@@ -2871,6 +2999,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
@@ -3016,6 +3165,11 @@ module Google
       class RunAggregationQueryRequest
         include Google::Apis::Core::Hashable
       
+        # Explain options for the query.
+        # Corresponds to the JSON property `explainOptions`
+        # @return [Google::Apis::FirestoreV1::ExplainOptions]
+        attr_accessor :explain_options
+      
         # Options for creating a new transaction.
         # Corresponds to the JSON property `newTransaction`
         # @return [Google::Apis::FirestoreV1::TransactionOptions]
@@ -3046,6 +3200,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @explain_options = args[:explain_options] if args.key?(:explain_options)
           @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)
@@ -3057,6 +3212,11 @@ module Google
       class RunAggregationQueryResponse
         include Google::Apis::Core::Hashable
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::FirestoreV1::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
@@ -3086,6 +3246,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)
@@ -3096,6 +3257,11 @@ module Google
       class RunQueryRequest
         include Google::Apis::Core::Hashable
       
+        # Explain options for the query.
+        # Corresponds to the JSON property `explainOptions`
+        # @return [Google::Apis::FirestoreV1::ExplainOptions]
+        attr_accessor :explain_options
+      
         # Options for creating a new transaction.
         # Corresponds to the JSON property `newTransaction`
         # @return [Google::Apis::FirestoreV1::TransactionOptions]
@@ -3127,6 +3293,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @explain_options = args[:explain_options] if args.key?(:explain_options)
           @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)
@@ -3150,6 +3317,11 @@ module Google
         attr_accessor :done
         alias_method :done?, :done
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::FirestoreV1::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
@@ -3181,6 +3353,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)
@@ -3264,6 +3437,11 @@ module Google
         # @return [Google::Apis::FirestoreV1::Cursor]
         attr_accessor :end_at
       
+        # Nearest Neighbors search config.
+        # Corresponds to the JSON property `findNearest`
+        # @return [Google::Apis::FirestoreV1::FindNearest]
+        attr_accessor :find_nearest
+      
         # The collections to query.
         # Corresponds to the JSON property `from`
         # @return [Array<Google::Apis::FirestoreV1::CollectionSelector>]
@@ -3322,6 +3500,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @end_at = args[:end_at] if args.key?(:end_at)
+          @find_nearest = args[:find_nearest] if args.key?(:find_nearest)
           @from = args[:from] if args.key?(:from)
           @limit = args[:limit] if args.key?(:limit)
           @offset = args[:offset] if args.key?(:offset)

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.62.0"
+      GEM_VERSION = "0.64.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240307"
+      REVISION = "20240324"
     end
   end
 end

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

@@ -178,12 +178,30 @@ 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
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class FieldFilter
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -208,6 +226,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class FindNearest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1Backup
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -514,6 +538,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
       
@@ -883,6 +913,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
@@ -893,6 +933,23 @@ module Google
         end
       end
       
+      class ExplainMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :execution_stats, as: 'executionStats', class: Google::Apis::FirestoreV1::ExecutionStats, decorator: Google::Apis::FirestoreV1::ExecutionStats::Representation
+      
+          property :plan_summary, as: 'planSummary', class: Google::Apis::FirestoreV1::PlanSummary, decorator: Google::Apis::FirestoreV1::PlanSummary::Representation
+      
+        end
+      end
+      
+      class ExplainOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analyze, as: 'analyze'
+        end
+      end
+      
       class FieldFilter
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -941,6 +998,18 @@ module Google
         end
       end
       
+      class FindNearest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :distance_measure, as: 'distanceMeasure'
+          property :limit, as: 'limit'
+          property :query_vector, as: 'queryVector', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
+      
+          property :vector_field, as: 'vectorField', class: Google::Apis::FirestoreV1::FieldReference, decorator: Google::Apis::FirestoreV1::FieldReference::Representation
+      
+        end
+      end
+      
       class GoogleFirestoreAdminV1Backup
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1447,6 +1516,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
@@ -1496,6 +1572,8 @@ module Google
       class RunAggregationQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :explain_options, as: 'explainOptions', class: Google::Apis::FirestoreV1::ExplainOptions, decorator: Google::Apis::FirestoreV1::ExplainOptions::Representation
+      
           property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
       
           property :read_time, as: 'readTime'
@@ -1508,6 +1586,8 @@ module Google
       class RunAggregationQueryResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::FirestoreV1::ExplainMetrics, decorator: Google::Apis::FirestoreV1::ExplainMetrics::Representation
+      
           property :read_time, as: 'readTime'
           property :result, as: 'result', class: Google::Apis::FirestoreV1::AggregationResult, decorator: Google::Apis::FirestoreV1::AggregationResult::Representation
       
@@ -1518,6 +1598,8 @@ module Google
       class RunQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :explain_options, as: 'explainOptions', class: Google::Apis::FirestoreV1::ExplainOptions, decorator: Google::Apis::FirestoreV1::ExplainOptions::Representation
+      
           property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
       
           property :read_time, as: 'readTime'
@@ -1533,6 +1615,8 @@ module Google
           property :document, as: 'document', class: Google::Apis::FirestoreV1::Document, decorator: Google::Apis::FirestoreV1::Document::Representation
       
           property :done, as: 'done'
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::FirestoreV1::ExplainMetrics, decorator: Google::Apis::FirestoreV1::ExplainMetrics::Representation
+      
           property :read_time, as: 'readTime'
           property :skipped_results, as: 'skippedResults'
           property :transaction, :base64 => true, as: 'transaction'
@@ -1563,6 +1647,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :end_at, as: 'endAt', class: Google::Apis::FirestoreV1::Cursor, decorator: Google::Apis::FirestoreV1::Cursor::Representation
       
+          property :find_nearest, as: 'findNearest', class: Google::Apis::FirestoreV1::FindNearest, decorator: Google::Apis::FirestoreV1::FindNearest::Representation
+      
           collection :from, as: 'from', class: Google::Apis::FirestoreV1::CollectionSelector, decorator: Google::Apis::FirestoreV1::CollectionSelector::Representation
       
           property :limit, as: 'limit'

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

@@ -383,8 +383,8 @@ module Google
         
         # Deletes a backup schedule.
         # @param [String] name
-        #   Required. The name of backup schedule. Format `projects/`project`/databases/`
-        #   database`/backupSchedules/`backup_schedule``
+        #   Required. The name of the backup schedule. Format `projects/`project`/
+        #   databases/`database`/backupSchedules/`backup_schedule``
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.62.0
+  version: 0.64.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-17 00:00:00.000000000 Z
+date: 2024-03-31 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.62.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.64.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []