google-apis-firestore_v1 0.58.0 → 0.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0beae9ba07ac9d58436be97ef38c7b3a018ce45066c2092e6b55b0f2a03611e
-  data.tar.gz: a986a656df5269e66f6cdedd427dbf43040720431ef1fc60a39f595a74a9f671
+  metadata.gz: fedadd7cdb074145da950c43314396e867330291a06dc596bcad1f45bb216489
+  data.tar.gz: 718975c306c05e45058dc74f6bac3761424ba7962c1e3da48ab67ed43a1682de
 SHA512:
-  metadata.gz: a6b507be378adda4c22bc4f218ab1f37501e52ea67dac5552fe6182d3cebc097831d76b8a7170cdda67905a3dbfafc3e73b80ece90627e9b5d3e5e8104836e16
-  data.tar.gz: fd838f5219c50c0dd0b36c1324f51147eb55eb9e35ac485da45f215739c2e6216bbf07414a71a4a1cc32b0860fc86107d0f1c8e6614f645c8d818d17749de2a3
+  metadata.gz: 6341d7d6960d2b058e95a12f058ed3f96cb662a08f7aa2d9d820c0127ea063c098fa55d883007fdf6ae3d6f1a03590af8cfd62aff13a129a26e3fa30dbc89499
+  data.tar.gz: 893d5843ecbcef7f59d97918ddfbcc087ccaab67573c47c434adb4ad64783b287bfae4279b694769ac95525206ea829d3e3ea5c53b830f8621966fa9c0ce0da4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # 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

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)
@@ -2973,6 +3040,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 +3075,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)
@@ -3053,6 +3126,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 +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_query = args[:structured_query] if args.key?(:structured_query)

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.58.0"
+      GEM_VERSION = "0.59.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.13.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240131"
+      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
       
@@ -887,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
@@ -963,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
@@ -979,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'
@@ -1480,6 +1509,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'
@@ -1502,6 +1533,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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.58.0
+  version: 0.59.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-11 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.58.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: []