google-apis-firestore_v1 0.69.0 → 0.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d16f471b3b40e5ab66b70ad798c3c7d85b1ec87a8da42b04069323a8c66df9e
-  data.tar.gz: 3e88e8f1dad470cda3250815b666ec872fb53aa456fc98c6f32cdac014526e7d
+  metadata.gz: 170a49679c2ec0bc8d7584f22718d69d1df15bc6a2391c02d9fe836e6ab3e762
+  data.tar.gz: 3067869daf8155df44a8469baf3f8d5d85b9d1743261130debbd78fa8f201203
 SHA512:
-  metadata.gz: a7003b7135a8b834a42c37715dc0cb9dfe010d51576cb489a7584f05f861106f691ee464d8e9a3fc5b0ab54faef4dd290fafdefc775d044f369b2742359e9832
-  data.tar.gz: fec0d84aae9cf40d6989162a13e0209c5cd2e2aa73b9bbaab5b2202ce0f513d672c13cd66631395e98397405c33fa2c97353eaf47cc62b8a9ad248322c384404
+  metadata.gz: 0de30fa1441322ab8419c735dab23b8700074a183b58d3720d208ccd9b83023f717358bacb4e7a708db6c123e30a5152f26112df9102e97bccc9c25209df0187
+  data.tar.gz: ba8ee9c7733dee6709860412f287f737433e21de786e037f64f33dc7509f498f99eb5d951999bf008734e82ce1ba79cfa853a784ed2a81fc82f65223d6209dc4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1
 
+### v0.71.0 (2024-09-01)
+
+* Regenerated from discovery document revision 20240822
+
+### v0.70.0 (2024-08-11)
+
+* Regenerated from discovery document revision 20240804
+* Regenerated using generator version 0.15.1
+
 ### v0.69.0 (2024-07-25)
 
 * Regenerated from discovery document revision 20240713

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

@@ -637,10 +637,7 @@ module Google
       # A Document has changed. May be the result of multiple writes, including
       # deletes, that ultimately resulted in a new value for the Document. Multiple
       # DocumentChange messages may be returned for the same logical change, if
-      # multiple targets are affected. For PipelineQueryTargets, `document` will be in
-      # the new pipeline format, For a Listen stream with both QueryTargets and
-      # PipelineQueryTargets present, if a document matches both types of queries,
-      # then a separate DocumentChange messages will be sent out one for each set.
+      # multiple targets are affected.
       class DocumentChange
         include Google::Apis::Core::Hashable
       
@@ -1112,6 +1109,22 @@ module Google
         # @return [String]
         attr_accessor :distance_measure
       
+        # Optional. Optional name of the field to output the result of the vector
+        # distance calculation. Must conform to document field name limitations.
+        # Corresponds to the JSON property `distanceResultField`
+        # @return [String]
+        attr_accessor :distance_result_field
+      
+        # Optional. Option to specify a threshold for which no less similar documents
+        # will be returned. The behavior of the specified `distance_measure` will affect
+        # the meaning of the distance threshold. Since DOT_PRODUCT distances increase
+        # when the vectors are more similar, the comparison is inverted. For EUCLIDEAN,
+        # COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >=
+        # distance_threshold
+        # Corresponds to the JSON property `distanceThreshold`
+        # @return [Float]
+        attr_accessor :distance_threshold
+      
         # Required. The number of nearest neighbors to return. Must be a positive
         # integer of no more than 1000.
         # Corresponds to the JSON property `limit`
@@ -1135,6 +1148,8 @@ module Google
         # Update properties of this object
         def update!(**args)
           @distance_measure = args[:distance_measure] if args.key?(:distance_measure)
+          @distance_result_field = args[:distance_result_field] if args.key?(:distance_result_field)
+          @distance_threshold = args[:distance_threshold] if args.key?(:distance_threshold)
           @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)
@@ -1265,7 +1280,7 @@ module Google
       class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
         include Google::Apis::Core::Hashable
       
-        # The ids of the collection groups that are being deleted.
+        # The IDs of the collection groups that are being deleted.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
@@ -1276,7 +1291,7 @@ module Google
         # @return [String]
         attr_accessor :end_time
       
-        # Which namespace ids are being deleted.
+        # Which namespace IDs are being deleted.
         # Corresponds to the JSON property `namespaceIds`
         # @return [Array<String>]
         attr_accessor :namespace_ids
@@ -1409,6 +1424,31 @@ module Google
         end
       end
       
+      # The configuration options for using CMEK (Customer Managed Encryption Key)
+      # encryption.
+      class GoogleFirestoreAdminV1CustomerManagedEncryptionOptions
+        include Google::Apis::Core::Hashable
+      
+        # Required. Only keys in the same location as the 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)
+          @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
+        end
+      end
+      
       # Represents a recurring schedule that runs every day. The time zone is UTC.
       class GoogleFirestoreAdminV1DailyRecurrence
         include Google::Apis::Core::Hashable
@@ -1478,7 +1518,7 @@ module Google
         attr_accessor :etag
       
         # Output only. The key_prefix for this database. This key_prefix is used, in
-        # combination with the project id ("~") to construct the application id that is
+        # combination with the project ID ("~") to construct the application ID that is
         # returned from the Cloud Datastore APIs in Google App Engine first generation
         # runtimes. This value may be empty in which case the appid to use for URL-
         # encoded keys is the project_id (eg: foo instead of v~foo).
@@ -1575,12 +1615,45 @@ module Google
         end
       end
       
+      # Encryption configuration for a new database being created from another source.
+      # The source could be a Backup .
+      class GoogleFirestoreAdminV1EncryptionConfig
+        include Google::Apis::Core::Hashable
+      
+        # The configuration options for using CMEK (Customer Managed Encryption Key)
+        # encryption.
+        # Corresponds to the JSON property `customerManagedEncryption`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CustomerManagedEncryptionOptions]
+        attr_accessor :customer_managed_encryption
+      
+        # The configuration options for using Google default encryption.
+        # Corresponds to the JSON property `googleDefaultEncryption`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions]
+        attr_accessor :google_default_encryption
+      
+        # The configuration options for using the same encryption method as the source.
+        # Corresponds to the JSON property `useSourceEncryption`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceEncryptionOptions]
+        attr_accessor :use_source_encryption
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @customer_managed_encryption = args[:customer_managed_encryption] if args.key?(:customer_managed_encryption)
+          @google_default_encryption = args[:google_default_encryption] if args.key?(:google_default_encryption)
+          @use_source_encryption = args[:use_source_encryption] if args.key?(:use_source_encryption)
+        end
+      end
+      
       # Metadata for google.longrunning.Operation results from FirestoreAdmin.
       # ExportDocuments.
       class GoogleFirestoreAdminV1ExportDocumentsMetadata
         include Google::Apis::Core::Hashable
       
-        # Which collection ids are being exported.
+        # Which collection IDs are being exported.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
@@ -1591,7 +1664,7 @@ module Google
         # @return [String]
         attr_accessor :end_time
       
-        # Which namespace ids are being exported.
+        # Which namespace IDs are being exported.
         # Corresponds to the JSON property `namespaceIds`
         # @return [Array<String>]
         attr_accessor :namespace_ids
@@ -1652,8 +1725,8 @@ module Google
       class GoogleFirestoreAdminV1ExportDocumentsRequest
         include Google::Apis::Core::Hashable
       
-        # Which collection ids to export. Unspecified means all collections. Each
-        # collection id in this list must be unique.
+        # Which collection IDs to export. Unspecified means all collections. Each
+        # collection ID in this list must be unique.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
@@ -1723,7 +1796,7 @@ module Google
       
       # Represents a single field in the database. Fields are grouped by their "
       # Collection Group", which represent all collections in the database with the
-      # same id.
+      # same ID.
       class GoogleFirestoreAdminV1Field
         include Google::Apis::Core::Hashable
       
@@ -1854,12 +1927,25 @@ module Google
         end
       end
       
+      # The configuration options for using Google default encryption.
+      class GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Metadata for google.longrunning.Operation results from FirestoreAdmin.
       # ImportDocuments.
       class GoogleFirestoreAdminV1ImportDocumentsMetadata
         include Google::Apis::Core::Hashable
       
-        # Which collection ids are being imported.
+        # Which collection IDs are being imported.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
@@ -1875,7 +1961,7 @@ module Google
         # @return [String]
         attr_accessor :input_uri_prefix
       
-        # Which namespace ids are being imported.
+        # Which namespace IDs are being imported.
         # Corresponds to the JSON property `namespaceIds`
         # @return [Array<String>]
         attr_accessor :namespace_ids
@@ -1923,8 +2009,8 @@ module Google
       class GoogleFirestoreAdminV1ImportDocumentsRequest
         include Google::Apis::Core::Hashable
       
-        # Which collection ids to import. Unspecified means all collections included in
-        # the import. Each collection id in this list must be unique.
+        # Which collection IDs to import. Unspecified means all collections included in
+        # the import. Each collection ID in this list must be unique.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
@@ -1989,10 +2075,10 @@ module Google
       
         # Indexes with a collection query scope specified allow queries against a
         # collection that is the child of a specific document, specified at query time,
-        # and that has the same collection id. Indexes with a collection group query
+        # and that has the same collection ID. Indexes with a collection group query
         # scope specified allow queries against all collections descended from a
         # specific document, specified at query time, and that have the same collection
-        # id as this index.
+        # ID as this index.
         # Corresponds to the JSON property `queryScope`
         # @return [String]
         attr_accessor :query_scope
@@ -2408,49 +2494,29 @@ module Google
       class GoogleFirestoreAdminV1RestoreDatabaseRequest
         include Google::Apis::Core::Hashable
       
-        # Backup to restore from. Must be from the same project as the parent. The
-        # restored database will be created in the same location as the source backup.
-        # Format is: `projects/`project_id`/locations/`location`/backups/`backup``
+        # Required. Backup to restore from. Must be from the same project as the parent.
+        # The restored database will be created in the same location as the source
+        # backup. Format is: `projects/`project_id`/locations/`location`/backups/`backup`
+        # `
         # Corresponds to the JSON property `backup`
         # @return [String]
         attr_accessor :backup
       
         # Required. The ID to use for the database, which will become the final
-        # component of the database's resource name. This database id must not be
+        # component of the database's resource name. This database ID must not be
         # associated with an existing database. This value should be 4-63 characters.
         # Valid characters are /a-z-/ with first character a letter and the last a
         # letter or a number. Must not be UUID-like /[0-9a-f]`8`(-[0-9a-f]`4`)`3`-[0-9a-
-        # f]`12`/. "(default)" database id is also valid.
+        # f]`12`/. "(default)" database ID is also valid.
         # Corresponds to the JSON property `databaseId`
         # @return [String]
         attr_accessor :database_id
       
-        # Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the
-        # same location as the restored 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
-      
-        # A generic empty message that you can re-use to avoid defining duplicated empty
-        # messages in your APIs. A typical example is to use it as the request or the
-        # response type of an API method. For instance: service Foo ` rpc Bar(google.
-        # protobuf.Empty) returns (google.protobuf.Empty); `
-        # Corresponds to the JSON property `useBackupEncryption`
-        # @return [Google::Apis::FirestoreV1::Empty]
-        attr_accessor :use_backup_encryption
-      
-        # A generic empty message that you can re-use to avoid defining duplicated empty
-        # messages in your APIs. A typical example is to use it as the request or the
-        # response type of an API method. For instance: service Foo ` rpc Bar(google.
-        # protobuf.Empty) returns (google.protobuf.Empty); `
-        # Corresponds to the JSON property `useGoogleDefaultEncryption`
-        # @return [Google::Apis::FirestoreV1::Empty]
-        attr_accessor :use_google_default_encryption
+        # Encryption configuration for a new database being created from another source.
+        # The source could be a Backup .
+        # Corresponds to the JSON property `encryptionConfig`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig]
+        attr_accessor :encryption_config
       
         def initialize(**args)
            update!(**args)
@@ -2460,9 +2526,20 @@ module Google
         def update!(**args)
           @backup = args[:backup] if args.key?(:backup)
           @database_id = args[:database_id] if args.key?(:database_id)
-          @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
-          @use_backup_encryption = args[:use_backup_encryption] if args.key?(:use_backup_encryption)
-          @use_google_default_encryption = args[:use_google_default_encryption] if args.key?(:use_google_default_encryption)
+          @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
+        end
+      end
+      
+      # The configuration options for using the same encryption method as the source.
+      class GoogleFirestoreAdminV1SourceEncryptionOptions
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
         end
       end
       
@@ -2877,10 +2954,7 @@ module Google
         # A Document has changed. May be the result of multiple writes, including
         # deletes, that ultimately resulted in a new value for the Document. Multiple
         # DocumentChange messages may be returned for the same logical change, if
-        # multiple targets are affected. For PipelineQueryTargets, `document` will be in
-        # the new pipeline format, For a Listen stream with both QueryTargets and
-        # PipelineQueryTargets present, if a document matches both types of queries,
-        # then a separate DocumentChange messages will be sent out one for each set.
+        # multiple targets are affected.
         # Corresponds to the JSON property `documentChange`
         # @return [Google::Apis::FirestoreV1::DocumentChange]
         attr_accessor :document_change

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.69.0"
+      GEM_VERSION = "0.71.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.15.0"
+      GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240713"
+      REVISION = "20240822"
     end
   end
 end

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

@@ -268,6 +268,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1CustomerManagedEncryptionOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1DailyRecurrence
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -286,6 +292,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1EncryptionConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1ExportDocumentsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -322,6 +334,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1ImportDocumentsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -418,6 +436,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1SourceEncryptionOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1Stats
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1008,6 +1032,8 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :distance_measure, as: 'distanceMeasure'
+          property :distance_result_field, as: 'distanceResultField'
+          property :distance_threshold, as: 'distanceThreshold'
           property :limit, as: 'limit'
           property :query_vector, as: 'queryVector', class: Google::Apis::FirestoreV1::Value, decorator: Google::Apis::FirestoreV1::Value::Representation
       
@@ -1082,6 +1108,13 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1CustomerManagedEncryptionOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :kms_key_name, as: 'kmsKeyName'
+        end
+      end
+      
       class GoogleFirestoreAdminV1DailyRecurrence
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1118,6 +1151,18 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1EncryptionConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :customer_managed_encryption, as: 'customerManagedEncryption', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CustomerManagedEncryptionOptions, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CustomerManagedEncryptionOptions::Representation
+      
+          property :google_default_encryption, as: 'googleDefaultEncryption', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions::Representation
+      
+          property :use_source_encryption, as: 'useSourceEncryption', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceEncryptionOptions, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceEncryptionOptions::Representation
+      
+        end
+      end
+      
       class GoogleFirestoreAdminV1ExportDocumentsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1187,6 +1232,12 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleFirestoreAdminV1ImportDocumentsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1345,11 +1396,14 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :backup, as: 'backup'
           property :database_id, as: 'databaseId'
-          property :kms_key_name, as: 'kmsKeyName'
-          property :use_backup_encryption, as: 'useBackupEncryption', class: Google::Apis::FirestoreV1::Empty, decorator: Google::Apis::FirestoreV1::Empty::Representation
+          property :encryption_config, as: 'encryptionConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig::Representation
       
-          property :use_google_default_encryption, as: 'useGoogleDefaultEncryption', class: Google::Apis::FirestoreV1::Empty, decorator: Google::Apis::FirestoreV1::Empty::Representation
+        end
+      end
       
+      class GoogleFirestoreAdminV1SourceEncryptionOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
         end
       end
       

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

@@ -100,7 +100,7 @@ module Google
         #   component of the database's resource name. This value should be 4-63
         #   characters. Valid characters are /a-z-/ with first character a letter and the
         #   last a letter or a number. Must not be UUID-like /[0-9a-f]`8`(-[0-9a-f]`4`)`3`-
-        #   [0-9a-f]`12`/. "(default)" database id is also valid.
+        #   [0-9a-f]`12`/. "(default)" database ID is also valid.
         # @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.69.0
+  version: 0.71.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-25 00:00:00.000000000 Z
+date: 2024-09-01 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.69.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.71.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []