google-apis-firestore_v1 0.70.0 → 0.72.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9814c9ea47ad8137d7cb51d9e958f6353147866479f43c8a39ae4303c3ceed
-  data.tar.gz: 8fbd0f080975a9f6c9f1c521e655881de21ee98ccbe5c4e9fbc73e13a7212c34
+  metadata.gz: '099ab181e600f641d7a370fb79701d48c058a38d5fa73b2f90d9bd0692b8fce7'
+  data.tar.gz: 1710b7d9541668b11632a793744e08191a1ec16c1c6af224e8de9bf76540497b
 SHA512:
-  metadata.gz: df4834a5c9031374ef3d6189444136d69211904d361059c0141358c96ec6d4fcaeb550642ee3c92e1118aa5c4dbabf9750a34e3d9cbac3778831fe49ed43499d
-  data.tar.gz: 964f83ec219d45851c43a0a80ee1995784fc2727f2dc6887ee268d554af4bf0ef2caef7dc3a40636406d684cccd5e6c1a6844fd47e0c70f34cb0a8b090a26d82
+  metadata.gz: dcc2475bda177a7c443b6fa4648db385237a5780fa9dc0940922c12b01bd017d85829b81f5b6724bf16b2a9affa00921b23e241468f8a86dc872a1247c73dc27
+  data.tar.gz: 30c3be690a5703c397e972cc80f1044350db698cf7c4c7a61bd09be7fd2a67ed907eefba1776a9bac0f2c41ff562367a7ba6770d6aebb5ee4e2133b7ca05a264

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-firestore_v1
 
+### v0.72.0 (2024-09-15)
+
+* Regenerated from discovery document revision 20240904
+
+### 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)
@@ -1257,12 +1275,32 @@ module Google
         end
       end
       
+      # Information about a backup that was used to restore a database.
+      class GoogleFirestoreAdminV1BackupSource
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the backup that was used to restore this database. Format:
+        # `projects/`project`/locations/`location`/backups/`backup``.
+        # Corresponds to the JSON property `backup`
+        # @return [String]
+        attr_accessor :backup
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @backup = args[:backup] if args.key?(:backup)
+        end
+      end
+      
       # Metadata for google.longrunning.Operation results from FirestoreAdmin.
       # BulkDeleteDocuments.
       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 +1311,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 +1538,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).
@@ -1531,6 +1569,11 @@ module Google
         # @return [String]
         attr_accessor :previous_id
       
+        # Information about the provenance of this database.
+        # Corresponds to the JSON property `sourceInfo`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceInfo]
+        attr_accessor :source_info
+      
         # The type of the database. See https://cloud.google.com/datastore/docs/
         # firestore-or-datastore for information about how to choose.
         # Corresponds to the JSON property `type`
@@ -1577,6 +1620,7 @@ module Google
           @name = args[:name] if args.key?(:name)
           @point_in_time_recovery_enablement = args[:point_in_time_recovery_enablement] if args.key?(:point_in_time_recovery_enablement)
           @previous_id = args[:previous_id] if args.key?(:previous_id)
+          @source_info = args[:source_info] if args.key?(:source_info)
           @type = args[:type] if args.key?(:type)
           @uid = args[:uid] if args.key?(:uid)
           @update_time = args[:update_time] if args.key?(:update_time)
@@ -1598,7 +1642,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 +1679,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 +1690,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 +1751,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 +1822,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 +1971,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 +1987,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 +2035,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 +2101,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 +2520,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
@@ -2524,6 +2569,33 @@ module Google
         end
       end
       
+      # Information about the provenance of this database.
+      class GoogleFirestoreAdminV1SourceInfo
+        include Google::Apis::Core::Hashable
+      
+        # Information about a backup that was used to restore a database.
+        # Corresponds to the JSON property `backup`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSource]
+        attr_accessor :backup
+      
+        # The associated long-running operation. This field may not be set after the
+        # operation has completed. Format: `projects/`project`/databases/`database`/
+        # operations/`operation``.
+        # Corresponds to the JSON property `operation`
+        # @return [String]
+        attr_accessor :operation
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @backup = args[:backup] if args.key?(:backup)
+          @operation = args[:operation] if args.key?(:operation)
+        end
+      end
+      
       # Backup specific statistics.
       class GoogleFirestoreAdminV1Stats
         include Google::Apis::Core::Hashable

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.72.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 = "20240904"
     end
   end
 end

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

@@ -244,6 +244,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1BackupSource
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -442,6 +448,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1SourceInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1Stats
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1032,6 +1044,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
       
@@ -1068,6 +1082,13 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1BackupSource
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :backup, as: 'backup'
+        end
+      end
+      
       class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1136,6 +1157,8 @@ module Google
           property :name, as: 'name'
           property :point_in_time_recovery_enablement, as: 'pointInTimeRecoveryEnablement'
           property :previous_id, as: 'previousId'
+          property :source_info, as: 'sourceInfo', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceInfo, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SourceInfo::Representation
+      
           property :type, as: 'type'
           property :uid, as: 'uid'
           property :update_time, as: 'updateTime'
@@ -1405,6 +1428,15 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1SourceInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :backup, as: 'backup', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSource, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BackupSource::Representation
+      
+          property :operation, as: 'operation'
+        end
+      end
+      
       class GoogleFirestoreAdminV1Stats
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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
@@ -1838,6 +1838,13 @@ module Google
         #   locations/`location``. Use ``location` = '-'` to list backups from all
         #   locations for the given project. This allows listing backups from a single
         #   location or from all locations.
+        # @param [String] filter
+        #   An expression that filters the list of returned backups. A filter expression
+        #   consists of a field name, a comparison operator, and a value for filtering.
+        #   The value must be a string, a number, or a boolean. The comparison operator
+        #   must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the
+        #   contains operator. Filter rules are not case sensitive. The following fields
+        #   in the Backup are eligible for filtering: * `database_uid` (supports `=` only)
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -1855,11 +1862,12 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def list_project_location_backups(parent, fields: nil, quota_user: nil, options: nil, &block)
+        def list_project_location_backups(parent, filter: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1/{+parent}/backups', options)
           command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse::Representation
           command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListBackupsResponse
           command.params['parent'] = parent unless parent.nil?
+          command.query['filter'] = filter unless filter.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)

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.72.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-11 00:00:00.000000000 Z
+date: 2024-09-15 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.72.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []