google-apis-firestore_v1 0.67.0 → 0.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b481467d958456adbd319282e0bf54e0ccef002e1c8bd436420aa4ac171c647
-  data.tar.gz: 8ff15f67e2207b3facef81bd4b9e9e396f591ded6a2bcf91464dd6aec7529882
+  metadata.gz: 9d16f471b3b40e5ab66b70ad798c3c7d85b1ec87a8da42b04069323a8c66df9e
+  data.tar.gz: 3e88e8f1dad470cda3250815b666ec872fb53aa456fc98c6f32cdac014526e7d
 SHA512:
-  metadata.gz: 9dca20f7a7c7404ad4469e31121cb17707479c99a0c637024031419710fed15979fc5e956cd72c2229f5a8c1c440df0f9f8b706d6534c732d72ab1d2382ea2cb
-  data.tar.gz: f4f9f0c06b66fd24792281420728ef21a4764484d9fc66b1bc42c0cce794fa0c7194b7c679fabbbd64811730f38576075ba5d4137ef3a4f40db30be3caef58ee
+  metadata.gz: a7003b7135a8b834a42c37715dc0cb9dfe010d51576cb489a7584f05f861106f691ee464d8e9a3fc5b0ab54faef4dd290fafdefc775d044f369b2742359e9832
+  data.tar.gz: fec0d84aae9cf40d6989162a13e0209c5cd2e2aa73b9bbaab5b2202ce0f513d672c13cd66631395e98397405c33fa2c97353eaf47cc62b8a9ad248322c384404

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-firestore_v1
 
+### v0.69.0 (2024-07-25)
+
+* Regenerated from discovery document revision 20240713
+
+### v0.68.0 (2024-06-23)
+
+* Regenerated from discovery document revision 20240617
+
 ### v0.67.0 (2024-06-16)
 
 * Regenerated from discovery document revision 20240610

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

@@ -1100,7 +1100,10 @@ module Google
         end
       end
       
-      # Nearest Neighbors search config.
+      # Nearest Neighbors search config. The ordering provided by FindNearest
+      # supersedes the order_by stage. If multiple documents have the same vector
+      # distance, the returned document order is not guaranteed to be stable between
+      # queries.
       class FindNearest
         include Google::Apis::Core::Hashable
       
@@ -1223,7 +1226,8 @@ module Google
         attr_accessor :name
       
         # At what relative time in the future, compared to its creation time, the backup
-        # should be deleted, e.g. keep backups for 7 days.
+        # should be deleted, e.g. keep backups for 7 days. The maximum supported
+        # retention period is 14 weeks.
         # Corresponds to the JSON property `retention`
         # @return [String]
         attr_accessor :retention
@@ -1256,6 +1260,106 @@ module Google
         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.
+        # Corresponds to the JSON property `collectionIds`
+        # @return [Array<String>]
+        attr_accessor :collection_ids
+      
+        # The time this operation completed. Will be unset if operation still in
+        # progress.
+        # Corresponds to the JSON property `endTime`
+        # @return [String]
+        attr_accessor :end_time
+      
+        # Which namespace ids are being deleted.
+        # Corresponds to the JSON property `namespaceIds`
+        # @return [Array<String>]
+        attr_accessor :namespace_ids
+      
+        # The state of the operation.
+        # Corresponds to the JSON property `operationState`
+        # @return [String]
+        attr_accessor :operation_state
+      
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
+        # Corresponds to the JSON property `progressBytes`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress]
+        attr_accessor :progress_bytes
+      
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
+        # Corresponds to the JSON property `progressDocuments`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress]
+        attr_accessor :progress_documents
+      
+        # The timestamp that corresponds to the version of the database that is being
+        # read to get the list of documents to delete. This time can also be used as the
+        # timestamp of PITR in case of disaster recovery (subject to PITR window limit).
+        # Corresponds to the JSON property `snapshotTime`
+        # @return [String]
+        attr_accessor :snapshot_time
+      
+        # The time this operation started.
+        # Corresponds to the JSON property `startTime`
+        # @return [String]
+        attr_accessor :start_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @collection_ids = args[:collection_ids] if args.key?(:collection_ids)
+          @end_time = args[:end_time] if args.key?(:end_time)
+          @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids)
+          @operation_state = args[:operation_state] if args.key?(:operation_state)
+          @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes)
+          @progress_documents = args[:progress_documents] if args.key?(:progress_documents)
+          @snapshot_time = args[:snapshot_time] if args.key?(:snapshot_time)
+          @start_time = args[:start_time] if args.key?(:start_time)
+        end
+      end
+      
+      # The request for FirestoreAdmin.BulkDeleteDocuments. When both collection_ids
+      # and namespace_ids are set, only documents satisfying both conditions will be
+      # deleted. Requests with namespace_ids and collection_ids both empty will be
+      # rejected. Please use FirestoreAdmin.DeleteDatabase instead.
+      class GoogleFirestoreAdminV1BulkDeleteDocumentsRequest
+        include Google::Apis::Core::Hashable
+      
+        # Optional. IDs of the collection groups to delete. Unspecified means all
+        # collection groups. Each collection group in this list must be unique.
+        # Corresponds to the JSON property `collectionIds`
+        # @return [Array<String>]
+        attr_accessor :collection_ids
+      
+        # Optional. Namespaces to delete. An empty list means all namespaces. This is
+        # the recommended usage for databases that don't use namespaces. An empty string
+        # element represents the default namespace. This should be used if the database
+        # has data in non-default namespaces, but doesn't want to delete from them. Each
+        # namespace in this list must be unique.
+        # Corresponds to the JSON property `namespaceIds`
+        # @return [Array<String>]
+        attr_accessor :namespace_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @collection_ids = args[:collection_ids] if args.key?(:collection_ids)
+          @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids)
+        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.
@@ -1309,20 +1413,12 @@ module Google
       class GoogleFirestoreAdminV1DailyRecurrence
         include Google::Apis::Core::Hashable
       
-        # Represents a time of day. The date and time zone are either not significant or
-        # are specified elsewhere. An API may choose to allow leap seconds. Related
-        # types are google.type.Date and `google.protobuf.Timestamp`.
-        # Corresponds to the JSON property `time`
-        # @return [Google::Apis::FirestoreV1::TimeOfDay]
-        attr_accessor :time
-      
         def initialize(**args)
            update!(**args)
         end
       
         # Update properties of this object
         def update!(**args)
-          @time = args[:time] if args.key?(:time)
         end
       end
       
@@ -1466,32 +1562,6 @@ module Google
         end
       end
       
-      # A consistent snapshot of a database at a specific point in time.
-      class GoogleFirestoreAdminV1DatabaseSnapshot
-        include Google::Apis::Core::Hashable
-      
-        # Required. A name of the form `projects/`project_id`/databases/`database_id``
-        # Corresponds to the JSON property `database`
-        # @return [String]
-        attr_accessor :database
-      
-        # Required. The timestamp at which the database snapshot is taken. The requested
-        # timestamp must be a whole minute within the PITR window.
-        # Corresponds to the JSON property `snapshotTime`
-        # @return [String]
-        attr_accessor :snapshot_time
-      
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-          @database = args[:database] if args.key?(:database)
-          @snapshot_time = args[:snapshot_time] if args.key?(:snapshot_time)
-        end
-      end
-      
       # Metadata related to the delete database operation.
       class GoogleFirestoreAdminV1DeleteDatabaseMetadata
         include Google::Apis::Core::Hashable
@@ -2338,8 +2408,9 @@ module Google
       class GoogleFirestoreAdminV1RestoreDatabaseRequest
         include Google::Apis::Core::Hashable
       
-        # Backup to restore from. Must be from the same project as the parent. Format is:
-        # `projects/`project_id`/locations/`location`/backups/`backup``
+        # 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
@@ -2354,17 +2425,12 @@ module Google
         # @return [String]
         attr_accessor :database_id
       
-        # A consistent snapshot of a database at a specific point in time.
-        # Corresponds to the JSON property `databaseSnapshot`
-        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseSnapshot]
-        attr_accessor :database_snapshot
-      
         # Use Customer Managed Encryption Keys (CMEK) for encryption. 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`/
+        # 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]
@@ -2394,7 +2460,6 @@ module Google
         def update!(**args)
           @backup = args[:backup] if args.key?(:backup)
           @database_id = args[:database_id] if args.key?(:database_id)
-          @database_snapshot = args[:database_snapshot] if args.key?(:database_snapshot)
           @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)
@@ -2527,13 +2592,6 @@ module Google
         # @return [String]
         attr_accessor :day
       
-        # Represents a time of day. The date and time zone are either not significant or
-        # are specified elsewhere. An API may choose to allow leap seconds. Related
-        # types are google.type.Date and `google.protobuf.Timestamp`.
-        # Corresponds to the JSON property `time`
-        # @return [Google::Apis::FirestoreV1::TimeOfDay]
-        attr_accessor :time
-      
         def initialize(**args)
            update!(**args)
         end
@@ -2541,7 +2599,6 @@ module Google
         # Update properties of this object
         def update!(**args)
           @day = args[:day] if args.key?(:day)
-          @time = args[:time] if args.key?(:time)
         end
       end
       
@@ -3500,7 +3557,10 @@ module Google
         # @return [Google::Apis::FirestoreV1::Cursor]
         attr_accessor :end_at
       
-        # Nearest Neighbors search config.
+        # Nearest Neighbors search config. The ordering provided by FindNearest
+        # supersedes the order_by stage. If multiple documents have the same vector
+        # distance, the returned document order is not guaranteed to be stable between
+        # queries.
         # Corresponds to the JSON property `findNearest`
         # @return [Google::Apis::FirestoreV1::FindNearest]
         attr_accessor :find_nearest
@@ -3735,47 +3795,6 @@ module Google
         end
       end
       
-      # Represents a time of day. The date and time zone are either not significant or
-      # are specified elsewhere. An API may choose to allow leap seconds. Related
-      # types are google.type.Date and `google.protobuf.Timestamp`.
-      class TimeOfDay
-        include Google::Apis::Core::Hashable
-      
-        # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to
-        # allow the value "24:00:00" for scenarios like business closing time.
-        # Corresponds to the JSON property `hours`
-        # @return [Fixnum]
-        attr_accessor :hours
-      
-        # Minutes of hour of day. Must be from 0 to 59.
-        # Corresponds to the JSON property `minutes`
-        # @return [Fixnum]
-        attr_accessor :minutes
-      
-        # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
-        # Corresponds to the JSON property `nanos`
-        # @return [Fixnum]
-        attr_accessor :nanos
-      
-        # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
-        # allow the value 60 if it allows leap-seconds.
-        # Corresponds to the JSON property `seconds`
-        # @return [Fixnum]
-        attr_accessor :seconds
-      
-        def initialize(**args)
-           update!(**args)
-        end
-      
-        # Update properties of this object
-        def update!(**args)
-          @hours = args[:hours] if args.key?(:hours)
-          @minutes = args[:minutes] if args.key?(:minutes)
-          @nanos = args[:nanos] if args.key?(:nanos)
-          @seconds = args[:seconds] if args.key?(:seconds)
-        end
-      end
-      
       # Options for creating a new transaction.
       class TransactionOptions
         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.67.0"
+      GEM_VERSION = "0.69.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.15.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240610"
+      REVISION = "20240713"
     end
   end
 end

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

@@ -244,31 +244,37 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class GoogleFirestoreAdminV1CmekConfig
+      class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class GoogleFirestoreAdminV1CreateDatabaseMetadata
+      class GoogleFirestoreAdminV1BulkDeleteDocumentsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class GoogleFirestoreAdminV1DailyRecurrence
+      class GoogleFirestoreAdminV1CmekConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class GoogleFirestoreAdminV1Database
+      class GoogleFirestoreAdminV1CreateDatabaseMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1DailyRecurrence
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class GoogleFirestoreAdminV1DatabaseSnapshot
+      class GoogleFirestoreAdminV1Database
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
@@ -640,12 +646,6 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class TimeOfDay
-        class Representation < Google::Apis::Core::JsonRepresentation; end
-      
-        include Google::Apis::Core::JsonObjectSupport
-      end
-      
       class TransactionOptions
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1044,6 +1044,30 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :collection_ids, as: 'collectionIds'
+          property :end_time, as: 'endTime'
+          collection :namespace_ids, as: 'namespaceIds'
+          property :operation_state, as: 'operationState'
+          property :progress_bytes, as: 'progressBytes', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation
+      
+          property :progress_documents, as: 'progressDocuments', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation
+      
+          property :snapshot_time, as: 'snapshotTime'
+          property :start_time, as: 'startTime'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1BulkDeleteDocumentsRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :collection_ids, as: 'collectionIds'
+          collection :namespace_ids, as: 'namespaceIds'
+        end
+      end
+      
       class GoogleFirestoreAdminV1CmekConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1061,8 +1085,6 @@ module Google
       class GoogleFirestoreAdminV1DailyRecurrence
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :time, as: 'time', class: Google::Apis::FirestoreV1::TimeOfDay, decorator: Google::Apis::FirestoreV1::TimeOfDay::Representation
-      
         end
       end
       
@@ -1090,14 +1112,6 @@ module Google
         end
       end
       
-      class GoogleFirestoreAdminV1DatabaseSnapshot
-        # @private
-        class Representation < Google::Apis::Core::JsonRepresentation
-          property :database, as: 'database'
-          property :snapshot_time, as: 'snapshotTime'
-        end
-      end
-      
       class GoogleFirestoreAdminV1DeleteDatabaseMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1331,8 +1345,6 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :backup, as: 'backup'
           property :database_id, as: 'databaseId'
-          property :database_snapshot, as: 'databaseSnapshot', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseSnapshot, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseSnapshot::Representation
-      
           property :kms_key_name, as: 'kmsKeyName'
           property :use_backup_encryption, as: 'useBackupEncryption', class: Google::Apis::FirestoreV1::Empty, decorator: Google::Apis::FirestoreV1::Empty::Representation
       
@@ -1383,8 +1395,6 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :day, as: 'day'
-          property :time, as: 'time', class: Google::Apis::FirestoreV1::TimeOfDay, decorator: Google::Apis::FirestoreV1::TimeOfDay::Representation
-      
         end
       end
       
@@ -1716,16 +1726,6 @@ module Google
         end
       end
       
-      class TimeOfDay
-        # @private
-        class Representation < Google::Apis::Core::JsonRepresentation
-          property :hours, as: 'hours'
-          property :minutes, as: 'minutes'
-          property :nanos, as: 'nanos'
-          property :seconds, as: 'seconds'
-        end
-      end
-      
       class TransactionOptions
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -52,6 +52,45 @@ module Google
           @batch_path = 'batch'
         end
         
+        # Bulk deletes a subset of documents from Google Cloud Firestore. Documents
+        # created or updated after the underlying system starts to process the request
+        # will not be deleted. The bulk delete occurs in the background and its progress
+        # can be monitored and managed via the Operation resource that is created. For
+        # more details on bulk delete behavior, refer to: https://cloud.google.com/
+        # firestore/docs/manage-data/bulk-delete
+        # @param [String] name
+        #   Required. Database to operate. Should be of the form: `projects/`project_id`/
+        #   databases/`database_id``.
+        # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BulkDeleteDocumentsRequest] google_firestore_admin_v1_bulk_delete_documents_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirestoreV1::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation]
+        #
+        # @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 bulk_project_database_delete_documents(name, google_firestore_admin_v1_bulk_delete_documents_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/{+name}:bulkDeleteDocuments', options)
+          command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1BulkDeleteDocumentsRequest::Representation
+          command.request_object = google_firestore_admin_v1_bulk_delete_documents_request_object
+          command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Create a database.
         # @param [String] parent
         #   Required. A parent name of the form `projects/`project_id``

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.67.0
+  version: 0.69.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-16 00:00:00.000000000 Z
+date: 2024-07-25 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.67.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.69.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []