google-apis-firestore_v1 0.66.0 → 0.68.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa1f7c6a3a2b2f17c46a9e589aa60c220bd138ecacceac5c4d7d33d3ea23071b
-  data.tar.gz: 6090d477238a30779205c4a5871ff87e59b6fdefd55857749fadab77f1b214ae
+  metadata.gz: 55fa77a9da6977af6f6a8093919887293a4a8c885cbd70de201de28ef8aea920
+  data.tar.gz: 7c67acb04c961d86ef12c68eff94e931f21f76eba2e279bb144029dcd6b10dc4
 SHA512:
-  metadata.gz: 76832f251fa85d87844b7b91c9ee743b18ed20286aa722d6cbeb70c5549e3bd77ac0cd33fd4dcd566c75c12a13710801e5ebea56adb279885c9bf97362d02ad5
-  data.tar.gz: f48c2a21b484290c9352458b777b42e01e99245d21bf9a6763d532e08344f49a88db00a70a62947907058463a230c471f872d1883a8cefe12435c0da7e556d22
+  metadata.gz: 207058b7e8d61b18a027ceee70e57a7d6d6216d1c225a5c02f2c1745d3e04b606d9d2b5e3a9e901fbea607787bf21a3a3603e93dd58ebe6e40e4bd5d881665c3
+  data.tar.gz: efe4f6bc674ceae19ad6e246b5c4d18fd4973129dc330595c22ac304aa7db9d88bed272ab0000bfc277f121a16bde98104f08746e49c0d8938b7500d7de8a898

data/CHANGELOG.md

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

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

@@ -1256,6 +1256,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.
@@ -1466,32 +1566,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
@@ -1662,23 +1736,21 @@ module Google
         # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig]
         attr_accessor :index_config
       
-        # Required. A field name of the form `projects/`project_id`/databases/`
+        # Required. A field name of the form: `projects/`project_id`/databases/`
         # database_id`/collectionGroups/`collection_id`/fields/`field_path`` A field
-        # path may be a simple field name, e.g. `address` or a path to fields within
-        # map_value , e.g. `address.city`, or a special field path. The only valid
-        # special field is `*`, which represents any field. Field paths may be quoted
-        # using ` (backtick). The only character that needs to be escaped within a
+        # path can be a simple field name, e.g. `address` or a path to fields within `
+        # map_value` , e.g. `address.city`, or a special field path. The only valid
+        # special field is `*`, which represents any field. Field paths can be quoted
+        # using `` ` `` (backtick). The only character that must be escaped within a
         # quoted field path is the backtick character itself, escaped using a backslash.
-        # Special characters in field paths that must be quoted include: `*`, `.`, ``` (
-        # backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note:
-        # Comments here are written in markdown syntax, so there is an additional layer
-        # of backticks to represent a code block) `\`address.city\`` represents a field
-        # named `address.city`, not the map key `city` in the field `address`. `\`*\``
-        # represents a field named `*`, not any field. A special `Field` contains the
-        # default indexing settings for all fields. This field's resource name is: `
-        # projects/`project_id`/databases/`database_id`/collectionGroups/__default__/
-        # fields/*` Indexes defined on this `Field` will be applied to all fields which
-        # do not have their own `Field` index configuration.
+        # Special characters in field paths that must be quoted include: `*`, `.`, `` ` `
+        # ` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: ``
+        # `address.city` `` represents a field named `address.city`, not the map key `
+        # city` in the field `address`. `` `*` `` represents a field named `*`, not any
+        # field. A special `Field` contains the default indexing settings for all fields.
+        # This field's resource name is: `projects/`project_id`/databases/`database_id`/
+        # collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be
+        # applied to all fields which do not have their own `Field` index configuration.
         # Corresponds to the JSON property `name`
         # @return [String]
         attr_accessor :name
@@ -2356,10 +2428,32 @@ 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`/
+        # 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
       
         def initialize(**args)
            update!(**args)
@@ -2369,7 +2463,9 @@ 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)
         end
       end
       

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.66.0"
+      GEM_VERSION = "0.68.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 = "20240521"
+      REVISION = "20240617"
     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
@@ -1044,6 +1050,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
@@ -1090,14 +1120,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,7 +1353,10 @@ 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
+      
+          property :use_google_default_encryption, as: 'useGoogleDefaultEncryption', class: Google::Apis::FirestoreV1::Empty, decorator: Google::Apis::FirestoreV1::Empty::Representation
       
         end
       end

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``
@@ -603,23 +642,21 @@ module Google
         # database, use the special `Field` with resource name: `projects/`project_id`/
         # databases/`database_id`/collectionGroups/__default__/fields/*`.
         # @param [String] name
-        #   Required. A field name of the form `projects/`project_id`/databases/`
+        #   Required. A field name of the form: `projects/`project_id`/databases/`
         #   database_id`/collectionGroups/`collection_id`/fields/`field_path`` A field
-        #   path may be a simple field name, e.g. `address` or a path to fields within
-        #   map_value , e.g. `address.city`, or a special field path. The only valid
-        #   special field is `*`, which represents any field. Field paths may be quoted
-        #   using ` (backtick). The only character that needs to be escaped within a
+        #   path can be a simple field name, e.g. `address` or a path to fields within `
+        #   map_value` , e.g. `address.city`, or a special field path. The only valid
+        #   special field is `*`, which represents any field. Field paths can be quoted
+        #   using `` ` `` (backtick). The only character that must be escaped within a
         #   quoted field path is the backtick character itself, escaped using a backslash.
-        #   Special characters in field paths that must be quoted include: `*`, `.`, ``` (
-        #   backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note:
-        #   Comments here are written in markdown syntax, so there is an additional layer
-        #   of backticks to represent a code block) `\`address.city\`` represents a field
-        #   named `address.city`, not the map key `city` in the field `address`. `\`*\``
-        #   represents a field named `*`, not any field. A special `Field` contains the
-        #   default indexing settings for all fields. This field's resource name is: `
-        #   projects/`project_id`/databases/`database_id`/collectionGroups/__default__/
-        #   fields/*` Indexes defined on this `Field` will be applied to all fields which
-        #   do not have their own `Field` index configuration.
+        #   Special characters in field paths that must be quoted include: `*`, `.`, `` ` `
+        #   ` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: ``
+        #   `address.city` `` represents a field named `address.city`, not the map key `
+        #   city` in the field `address`. `` `*` `` represents a field named `*`, not any
+        #   field. A special `Field` contains the default indexing settings for all fields.
+        #   This field's resource name is: `projects/`project_id`/databases/`database_id`/
+        #   collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be
+        #   applied to all fields which do not have their own `Field` index configuration.
         # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field] google_firestore_admin_v1_field_object
         # @param [String] update_mask
         #   A mask, relative to the field. If specified, only configuration specified by

metadata

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