google-apis-firestore_v1 0.57.0 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf35ac5ab5216d3a9791cdee286cc9ba9827680bb17a65226ab8b87b9954ae9a
-  data.tar.gz: 04e49bd9e54449bb102f89ba88c361a5db38f2bb3462d1f8a1d2159cb91f6437
+  metadata.gz: fedadd7cdb074145da950c43314396e867330291a06dc596bcad1f45bb216489
+  data.tar.gz: 718975c306c05e45058dc74f6bac3761424ba7962c1e3da48ab67ed43a1682de
 SHA512:
-  metadata.gz: b131fbd29589441e56abc870f53e84838a5e9a1baf999d55900db01d840c3ff68a97f656b73e92c8702aeafa46181fc5e6cf14e81e67fb851db0011ca8f766f8
-  data.tar.gz: 648f7ee4698de14c42b9d1fbd6dd62d8224b9a05f30a930dec2821bad0c9e9bff4a48d6b4c81931f04ccc18c746b215fe5a9d7aa06f52d806934ca379e3a9cad
+  metadata.gz: 6341d7d6960d2b058e95a12f058ed3f96cb662a08f7aa2d9d820c0127ea063c098fa55d883007fdf6ae3d6f1a03590af8cfd62aff13a129a26e3fa30dbc89499
+  data.tar.gz: 893d5843ecbcef7f59d97918ddfbcc087ccaab67573c47c434adb4ad64783b287bfae4279b694769ac95525206ea829d3e3ea5c53b830f8621966fa9c0ce0da4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1
 
+### v0.59.0 (2024-02-18)
+
+* Regenerated from discovery document revision 20240208
+
+### v0.58.0 (2024-02-11)
+
+* Regenerated from discovery document revision 20240131
+* Regenerated using generator version 0.13.1
+
 ### v0.57.0 (2024-01-23)
 
 * Regenerated from discovery document revision 20240117

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

@@ -869,6 +869,29 @@ module Google
         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
@@ -1126,6 +1149,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
@@ -1162,6 +1221,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 +1321,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)
@@ -2876,27 +2943,6 @@ 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
@@ -2970,35 +3016,6 @@ 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
@@ -3023,12 +3040,10 @@ 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
+        # 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`
@@ -3060,7 +3075,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @mode = args[:mode] if args.key?(:mode)
+          @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)
@@ -3088,11 +3103,6 @@ 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`
@@ -3108,7 +3118,6 @@ 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
@@ -3117,12 +3126,10 @@ 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
+        # 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`
@@ -3155,7 +3162,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
-          @mode = args[:mode] if args.key?(:mode)
+          @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)
@@ -3194,11 +3201,6 @@ 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.
@@ -3217,7 +3219,6 @@ 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

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

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

@@ -184,6 +184,12 @@ module Google
         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 +226,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
       
@@ -520,12 +532,6 @@ 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
       
@@ -544,12 +550,6 @@ 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
       
@@ -899,6 +899,13 @@ module Google
         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
@@ -975,6 +982,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
@@ -991,6 +1006,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'
@@ -1459,13 +1476,6 @@ 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
@@ -1489,15 +1499,6 @@ 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
@@ -1508,7 +1509,8 @@ module Google
       class RunAggregationQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :mode, as: 'mode'
+          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'
@@ -1524,8 +1526,6 @@ 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
@@ -1533,7 +1533,8 @@ module Google
       class RunQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :mode, as: 'mode'
+          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'
@@ -1551,8 +1552,6 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.59.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-02-18 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.57.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.59.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []