google-apis-firestore_v1 0.68.0 → 0.70.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55fa77a9da6977af6f6a8093919887293a4a8c885cbd70de201de28ef8aea920
-  data.tar.gz: 7c67acb04c961d86ef12c68eff94e931f21f76eba2e279bb144029dcd6b10dc4
+  metadata.gz: cd9814c9ea47ad8137d7cb51d9e958f6353147866479f43c8a39ae4303c3ceed
+  data.tar.gz: 8fbd0f080975a9f6c9f1c521e655881de21ee98ccbe5c4e9fbc73e13a7212c34
 SHA512:
-  metadata.gz: 207058b7e8d61b18a027ceee70e57a7d6d6216d1c225a5c02f2c1745d3e04b606d9d2b5e3a9e901fbea607787bf21a3a3603e93dd58ebe6e40e4bd5d881665c3
-  data.tar.gz: efe4f6bc674ceae19ad6e246b5c4d18fd4973129dc330595c22ac304aa7db9d88bed272ab0000bfc277f121a16bde98104f08746e49c0d8938b7500d7de8a898
+  metadata.gz: df4834a5c9031374ef3d6189444136d69211904d361059c0141358c96ec6d4fcaeb550642ee3c92e1118aa5c4dbabf9750a34e3d9cbac3778831fe49ed43499d
+  data.tar.gz: 964f83ec219d45851c43a0a80ee1995784fc2727f2dc6887ee268d554af4bf0ef2caef7dc3a40636406d684cccd5e6c1a6844fd47e0c70f34cb0a8b090a26d82

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1
 
+### 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
+
 ### v0.68.0 (2024-06-23)
 
 * Regenerated from discovery document revision 20240617

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
       
@@ -1100,7 +1097,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 +1223,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
@@ -1405,24 +1406,41 @@ 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
       
-        # 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
       
@@ -1579,6 +1597,39 @@ module Google
         end
       end
       
+      # Encryption configuration for a new database being created from another source.
+      # The source could be a Backup or a DatabaseSnapshot.
+      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
@@ -1858,6 +1909,19 @@ 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
@@ -2412,8 +2476,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
@@ -2428,32 +2493,11 @@ module Google
         # @return [String]
         attr_accessor :database_id
       
-        # 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
+        # Encryption configuration for a new database being created from another source.
+        # The source could be a Backup or a DatabaseSnapshot.
+        # Corresponds to the JSON property `encryptionConfig`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1EncryptionConfig]
+        attr_accessor :encryption_config
       
         def initialize(**args)
            update!(**args)
@@ -2463,9 +2507,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
       
@@ -2595,13 +2650,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
@@ -2609,7 +2657,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
       
@@ -2888,10 +2935,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
@@ -3568,7 +3612,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
@@ -3803,47 +3850,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.68.0"
+      GEM_VERSION = "0.70.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 = "20240617"
+      REVISION = "20240804"
     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
       
@@ -646,12 +670,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
       
@@ -1088,11 +1106,16 @@ module Google
         end
       end
       
-      class GoogleFirestoreAdminV1DailyRecurrence
+      class GoogleFirestoreAdminV1CustomerManagedEncryptionOptions
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :time, as: 'time', class: Google::Apis::FirestoreV1::TimeOfDay, decorator: Google::Apis::FirestoreV1::TimeOfDay::Representation
+          property :kms_key_name, as: 'kmsKeyName'
+        end
+      end
       
+      class GoogleFirestoreAdminV1DailyRecurrence
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
         end
       end
       
@@ -1126,6 +1149,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
@@ -1195,6 +1230,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
@@ -1353,11 +1394,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
       
@@ -1403,8 +1447,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
       
@@ -1736,16 +1778,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

metadata

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