google-apis-firestore_v1 0.70.0 → 0.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9814c9ea47ad8137d7cb51d9e958f6353147866479f43c8a39ae4303c3ceed
-  data.tar.gz: 8fbd0f080975a9f6c9f1c521e655881de21ee98ccbe5c4e9fbc73e13a7212c34
+  metadata.gz: 170a49679c2ec0bc8d7584f22718d69d1df15bc6a2391c02d9fe836e6ab3e762
+  data.tar.gz: 3067869daf8155df44a8469baf3f8d5d85b9d1743261130debbd78fa8f201203
 SHA512:
-  metadata.gz: df4834a5c9031374ef3d6189444136d69211904d361059c0141358c96ec6d4fcaeb550642ee3c92e1118aa5c4dbabf9750a34e3d9cbac3778831fe49ed43499d
-  data.tar.gz: 964f83ec219d45851c43a0a80ee1995784fc2727f2dc6887ee268d554af4bf0ef2caef7dc3a40636406d684cccd5e6c1a6844fd47e0c70f34cb0a8b090a26d82
+  metadata.gz: 0de30fa1441322ab8419c735dab23b8700074a183b58d3720d208ccd9b83023f717358bacb4e7a708db6c123e30a5152f26112df9102e97bccc9c25209df0187
+  data.tar.gz: ba8ee9c7733dee6709860412f287f737433e21de786e037f64f33dc7509f498f99eb5d951999bf008734e82ce1ba79cfa853a784ed2a81fc82f65223d6209dc4

data/CHANGELOG.md

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

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

@@ -1109,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`
@@ -1132,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)
@@ -1262,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
@@ -1273,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
@@ -1500,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).
@@ -1598,7 +1616,7 @@ module Google
       end
       
       # Encryption configuration for a new database being created from another source.
-      # The source could be a Backup or a DatabaseSnapshot.
+      # The source could be a Backup .
       class GoogleFirestoreAdminV1EncryptionConfig
         include Google::Apis::Core::Hashable
       
@@ -1635,7 +1653,7 @@ module Google
       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
@@ -1646,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
@@ -1707,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
@@ -1778,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
       
@@ -1927,7 +1945,7 @@ module Google
       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
@@ -1943,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
@@ -1991,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
@@ -2057,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
@@ -2476,25 +2494,26 @@ 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
       
         # Encryption configuration for a new database being created from another source.
-        # The source could be a Backup or a DatabaseSnapshot.
+        # The source could be a Backup .
         # Corresponds to the JSON property `encryptionConfig`
         # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig]
         attr_accessor :encryption_config

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

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

@@ -1032,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
       

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.70.0
+  version: 0.71.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-11 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.70.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: []