google-apis-firestore_v1 0.65.0 → 0.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7b832b4851d47d963cc19239084b1f456107a22c145d4aca569ff4a8eaee4e3
-  data.tar.gz: eb82f21be31b9ac64975973b97de4aa1af9046971ee686a6c519d922a4a4fdc7
+  metadata.gz: 3b481467d958456adbd319282e0bf54e0ccef002e1c8bd436420aa4ac171c647
+  data.tar.gz: 8ff15f67e2207b3facef81bd4b9e9e396f591ded6a2bcf91464dd6aec7529882
 SHA512:
-  metadata.gz: 75a98dcb4fb777db56328a761ba12d0ea4ac8f48c292ab9a84bc628266f331360a9323369054099f468f2e7b7cf977096da0e81b2d86c8b1e32f62abf0074e1f
-  data.tar.gz: b0909cf1b143399b1769361f250ed8c2915def7f1349e789ccf05adca647970db4d9c2f28ff178f72f59173aebafa56ccfc535f1f8a3a024934b67af8c55ae58
+  metadata.gz: 9dca20f7a7c7404ad4469e31121cb17707479c99a0c637024031419710fed15979fc5e956cd72c2229f5a8c1c440df0f9f8b706d6534c732d72ab1d2382ea2cb
+  data.tar.gz: f4f9f0c06b66fd24792281420728ef21a4764484d9fc66b1bc42c0cce794fa0c7194b7c679fabbbd64811730f38576075ba5d4137ef3a4f40db30be3caef58ee

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1
 
+### v0.67.0 (2024-06-16)
+
+* Regenerated from discovery document revision 20240610
+
+### v0.66.0 (2024-05-26)
+
+* Regenerated from discovery document revision 20240521
+* Regenerated using generator version 0.15.0
+
 ### v0.65.0 (2024-04-28)
 
 * Regenerated from discovery document revision 20240420

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

@@ -1309,12 +1309,20 @@ 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
       
@@ -1350,6 +1358,12 @@ module Google
         # @return [String]
         attr_accessor :delete_protection_state
       
+        # Output only. The timestamp at which this database was deleted. Only set if the
+        # database has been deleted.
+        # Corresponds to the JSON property `deleteTime`
+        # @return [String]
+        attr_accessor :delete_time
+      
         # Output only. The earliest timestamp at which older versions of the data can be
         # read from the database. See [version_retention_period] above; this field is
         # populated with `now - version_retention_period`. This value is continuously
@@ -1393,6 +1407,12 @@ module Google
         # @return [String]
         attr_accessor :point_in_time_recovery_enablement
       
+        # Output only. The database resource's prior database ID. This field is only
+        # populated for deleted databases.
+        # Corresponds to the JSON property `previousId`
+        # @return [String]
+        attr_accessor :previous_id
+      
         # 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`
@@ -1431,12 +1451,14 @@ module Google
           @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
           @create_time = args[:create_time] if args.key?(:create_time)
           @delete_protection_state = args[:delete_protection_state] if args.key?(:delete_protection_state)
+          @delete_time = args[:delete_time] if args.key?(:delete_time)
           @earliest_version_time = args[:earliest_version_time] if args.key?(:earliest_version_time)
           @etag = args[:etag] if args.key?(:etag)
           @key_prefix = args[:key_prefix] if args.key?(:key_prefix)
           @location_id = args[:location_id] if args.key?(:location_id)
           @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)
           @type = args[:type] if args.key?(:type)
           @uid = args[:uid] if args.key?(:uid)
           @update_time = args[:update_time] if args.key?(:update_time)
@@ -1560,7 +1582,8 @@ module Google
       class GoogleFirestoreAdminV1ExportDocumentsRequest
         include Google::Apis::Core::Hashable
       
-        # Which collection ids to export. Unspecified means all collections.
+        # 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
@@ -1639,23 +1662,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
@@ -1833,7 +1854,7 @@ module Google
         include Google::Apis::Core::Hashable
       
         # Which collection ids to import. Unspecified means all collections included in
-        # the import.
+        # the import. Each collection id in this list must be unique.
         # Corresponds to the JSON property `collectionIds`
         # @return [Array<String>]
         attr_accessor :collection_ids
@@ -2338,6 +2359,33 @@ module Google
         # @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)
         end
@@ -2347,6 +2395,9 @@ module Google
           @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
       
@@ -2476,6 +2527,13 @@ 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
@@ -2483,6 +2541,7 @@ 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
       
@@ -3676,6 +3735,47 @@ 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.65.0"
+      GEM_VERSION = "0.67.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.14.0"
+      GENERATOR_VERSION = "0.15.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240420"
+      REVISION = "20240610"
     end
   end
 end

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

@@ -640,6 +640,12 @@ 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
       
@@ -1055,6 +1061,8 @@ 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
       
@@ -1067,12 +1075,14 @@ module Google
           property :concurrency_mode, as: 'concurrencyMode'
           property :create_time, as: 'createTime'
           property :delete_protection_state, as: 'deleteProtectionState'
+          property :delete_time, as: 'deleteTime'
           property :earliest_version_time, as: 'earliestVersionTime'
           property :etag, as: 'etag'
           property :key_prefix, as: 'keyPrefix'
           property :location_id, as: 'locationId'
           property :name, as: 'name'
           property :point_in_time_recovery_enablement, as: 'pointInTimeRecoveryEnablement'
+          property :previous_id, as: 'previousId'
           property :type, as: 'type'
           property :uid, as: 'uid'
           property :update_time, as: 'updateTime'
@@ -1323,6 +1333,11 @@ module Google
           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
       
@@ -1368,6 +1383,8 @@ 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
       
@@ -1699,6 +1716,16 @@ 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

@@ -240,6 +240,8 @@ module Google
         # List all the databases in the project.
         # @param [String] parent
         #   Required. A parent name of the form `projects/`project_id``
+        # @param [Boolean] show_deleted
+        #   If true, also returns deleted resources.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -257,11 +259,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_databases(parent, fields: nil, quota_user: nil, options: nil, &block)
+        def list_project_databases(parent, show_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1/{+parent}/databases', options)
           command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse::Representation
           command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListDatabasesResponse
           command.params['parent'] = parent unless parent.nil?
+          command.query['showDeleted'] = show_deleted unless show_deleted.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
@@ -600,23 +603,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.65.0
+  version: 0.67.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-28 00:00:00.000000000 Z
+date: 2024-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -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.65.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.67.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []