google-apis-firestore_v1 0.61.0 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625f2448fafee1a983eb4672b2fc604fe3f84a6f136ce8bf42fc44a065cf2535
-  data.tar.gz: b0f5f888b239d7f128809c1cd10bd1ef7a47be5cb9bf9b35c26a62ad047c992f
+  metadata.gz: c6974b6fe903f1d7ee1557c20778bf8c5c41e2cca3d48aad1a2becd6f9e8d14b
+  data.tar.gz: 11dca6f1ef3fbc3b58229f4bd4164f6db06d0e71a0da8dd43cf3a6e5c3dcc497
 SHA512:
-  metadata.gz: 3fe19eb50de5b2b7ec8abb67d13e60295a573cf254c1f29d37959ae0f91d497ae138a912634a8c54c5c1e200cdd47dfe9ecf28a805c5d90b4967ca3cdecf1234
-  data.tar.gz: 7976c3701aaafddcdee8eeec5aa8d0fe385e44a866d039a62f8960888568656ff5eea69a082e7d07a750f90d7ba12bf6bf46c964f1e0e162e89c9e9b28bfbeb8
+  metadata.gz: 4871a8b91bd894379a92743002fa145a1df7e22cb95ad160e047aab88fcb6d2f925b173915cc12001aeccfab1b627cf9630fddb30e8a8c730c4f38076afaf46a
+  data.tar.gz: 5816f5db16f720a6868e31cfa7c0c15e6b1f1f3b8862de2f9facbb3f84dde666a7f01a8428f772a2b935aec9e02576e15a6071ceac6fd2daf9435282d51842b6

data/CHANGELOG.md

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

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
@@ -1079,7 +1169,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]
@@ -1126,6 +1216,42 @@ module Google
         end
       end
       
+      # The CMEK (Customer Managed Encryption Key) configuration for a Firestore
+      # database. If not present, the database is secured by the default Google
+      # encryption key.
+      class GoogleFirestoreAdminV1CmekConfig
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/
+        # docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.
+        # google.com/kms/docs/key-rotation), there can be multiple in-use key versions.
+        # The expected format is `projects/`project_id`/locations/`kms_location`/
+        # keyRings/`key_ring`/cryptoKeys/`crypto_key`/cryptoKeyVersions/`key_version``.
+        # Corresponds to the JSON property `activeKeyVersion`
+        # @return [Array<String>]
+        attr_accessor :active_key_version
+      
+        # Required. Only keys in the same location as this database are allowed to be
+        # used for encryption. For Firestore's nam5 multi-region, this corresponds to
+        # Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds
+        # to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/
+        # locations. The expected format is `projects/`project_id`/locations/`
+        # kms_location`/keyRings/`key_ring`/cryptoKeys/`crypto_key``.
+        # Corresponds to the JSON property `kmsKeyName`
+        # @return [String]
+        attr_accessor :kms_key_name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @active_key_version = args[:active_key_version] if args.key?(:active_key_version)
+          @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
+        end
+      end
+      
       # Metadata related to the create database operation.
       class GoogleFirestoreAdminV1CreateDatabaseMetadata
         include Google::Apis::Core::Hashable
@@ -1139,7 +1265,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
@@ -1162,6 +1288,13 @@ module Google
         # @return [String]
         attr_accessor :app_engine_integration_mode
       
+        # The CMEK (Customer Managed Encryption Key) configuration for a Firestore
+        # database. If not present, the database is secured by the default Google
+        # encryption key.
+        # Corresponds to the JSON property `cmekConfig`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig]
+        attr_accessor :cmek_config
+      
         # The concurrency control mode to use for this database.
         # Corresponds to the JSON property `concurrencyMode`
         # @return [String]
@@ -1255,6 +1388,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @app_engine_integration_mode = args[:app_engine_integration_mode] if args.key?(:app_engine_integration_mode)
+          @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
           @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
           @create_time = args[:create_time] if args.key?(:create_time)
           @delete_protection_state = args[:delete_protection_state] if args.key?(:delete_protection_state)
@@ -1943,8 +2077,7 @@ module Google
       class GoogleFirestoreAdminV1ListBackupsResponse
         include Google::Apis::Core::Hashable
       
-        # List of all backups for the project. Ordered by `location ASC, create_time
-        # DESC, name ASC`.
+        # List of all backups for the project.
         # Corresponds to the JSON property `backups`
         # @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Backup>]
         attr_accessor :backups
@@ -2828,6 +2961,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
@@ -2973,6 +3127,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]
@@ -3003,6 +3162,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)
@@ -3014,6 +3174,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
@@ -3043,6 +3208,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)
@@ -3053,6 +3219,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]
@@ -3084,6 +3255,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)
@@ -3107,6 +3279,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
@@ -3138,6 +3315,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_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.61.0"
+      GEM_VERSION = "0.63.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 = "20240226"
+      REVISION = "20240317"
     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
       
@@ -220,6 +238,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1CmekConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1CreateDatabaseMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -508,6 +532,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
       
@@ -877,6 +907,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
@@ -887,6 +927,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
@@ -963,6 +1020,14 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1CmekConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :active_key_version, as: 'activeKeyVersion'
+          property :kms_key_name, as: 'kmsKeyName'
+        end
+      end
+      
       class GoogleFirestoreAdminV1CreateDatabaseMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -979,6 +1044,8 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :app_engine_integration_mode, as: 'appEngineIntegrationMode'
+          property :cmek_config, as: 'cmekConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig::Representation
+      
           property :concurrency_mode, as: 'concurrencyMode'
           property :create_time, as: 'createTime'
           property :delete_protection_state, as: 'deleteProtectionState'
@@ -1431,6 +1498,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
@@ -1480,6 +1554,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'
@@ -1492,6 +1568,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
       
@@ -1502,6 +1580,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'
@@ -1517,6 +1597,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'

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.61.0
+  version: 0.63.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-03-24 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.61.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.63.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []