google-apis-firestore_v1 0.91.0 → 0.93.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c16c752719a127c27fb8460d340da9804a0e37ce5fab228df160e48bf7d308f2
-  data.tar.gz: 4cc88ccf9893db9bf586d729909d768cfeed9f35a9d0c416e105eed48e2f6014
+  metadata.gz: 9d6eed7354e0dc1a037993c8093fbbdaa48202c6f20801a8211569e97751c1d8
+  data.tar.gz: 4de78435271f435533cf85f2dab57d40d3853e801d068eed0b13a3a2e4d2ac9a
 SHA512:
-  metadata.gz: efc6220e9e71cda530a06ee5e818d58fe420e8f2cb02465abdb82113a6da76c43df648fcfc090f4800ceefeef2bcf0e3d122891299c794e32dd0478c20cda96c
-  data.tar.gz: 161d5ccd5e85315f3d337439b89303dbb4604033d5bd846d87de6055bb148497e65f62acf954cb23b738d6c6fcb54cdaa1c2dd8dd5358ccefa260adf9464b0f6
+  metadata.gz: c08041491bf8c5ea6502e38eeab659a44eca6a62e7db9c1ffa306781cbc71dd64d1c58cf1ec3c9eae5f66018959dd61355fcf2f1ee6d5b3531aa633038d000c6
+  data.tar.gz: 359c032e4e70a7962d97576035c4016921c1fb5319951133c95f9178204d422c97a2d5fea57b5f216a13fa77e91fd6216b262c72b7a8d0fbbff4a493735f1c05

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-firestore_v1
 
+### v0.93.0 (2026-05-10)
+
+* Regenerated from discovery document revision 20260427
+
+### v0.92.0 (2026-04-19)
+
+* Regenerated from discovery document revision 20260405
+
 ### v0.91.0 (2026-03-08)
 
 * Regenerated from discovery document revision 20260304

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

@@ -1759,9 +1759,14 @@ module Google
         # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig]
         attr_accessor :cmek_config
       
-        # The concurrency control mode to use for this database. If unspecified in a
-        # CreateDatabase request, this will default based on the database edition:
-        # Optimistic for Enterprise and Pessimistic for all other databases.
+        # The default concurrency control mode to use for this database. If unspecified
+        # in a CreateDatabase request, this will default based on the database edition:
+        # Optimistic for Enterprise and Pessimistic for all other databases. While
+        # transactions can explicitly specify their own concurrency mode, this setting
+        # defines the default behavior when left unspecified. Important: This database-
+        # level setting is not respected for Firestore with MongoDB compatibility. All
+        # transactions through the MongoDB compatibility layer will use optimistic
+        # concurrency control, regardless of this setting.
         # Corresponds to the JSON property `concurrencyMode`
         # @return [String]
         attr_accessor :concurrency_mode
@@ -2191,12 +2196,13 @@ module Google
         attr_accessor :name
       
         # The TTL (time-to-live) configuration for documents that have this `Field` set.
-        # Storing a timestamp value into a TTL-enabled field will be treated as the
-        # document's absolute expiration time. For Enterprise edition databases, the
-        # timestamp value may also be stored in an array value in the TTL-enabled field.
-        # Timestamp values in the past indicate that the document is eligible for
-        # immediate expiration. Using any other data type or leaving the field absent
-        # will disable expiration for the individual document.
+        # A timestamp stored in a TTL-enabled field will be used to determine the
+        # expiration time of the document. The expiration time is the sum of the
+        # timestamp value and the `expiration_offset`. For Enterprise edition databases,
+        # the timestamp value may alternatively be stored in an array value in the TTL-
+        # enabled field. An expiration time in the past indicates that the document is
+        # eligible for immediate expiration. Using any other data type or leaving the
+        # field absent will disable expiration for the individual document.
         # Corresponds to the JSON property `ttlConfig`
         # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1TtlConfig]
         attr_accessor :ttl_config
@@ -2467,6 +2473,11 @@ module Google
         # @return [String]
         attr_accessor :query_scope
       
+        # Options for search indexes at the definition level.
+        # Corresponds to the JSON property `searchIndexOptions`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchIndexOptions]
+        attr_accessor :search_index_options
+      
         # Optional. The number of shards for the index.
         # Corresponds to the JSON property `shardCount`
         # @return [Fixnum]
@@ -2496,6 +2507,7 @@ module Google
           @multikey = args[:multikey] if args.key?(:multikey)
           @name = args[:name] if args.key?(:name)
           @query_scope = args[:query_scope] if args.key?(:query_scope)
+          @search_index_options = args[:search_index_options] if args.key?(:search_index_options)
           @shard_count = args[:shard_count] if args.key?(:shard_count)
           @state = args[:state] if args.key?(:state)
           @unique = args[:unique] if args.key?(:unique)
@@ -2597,6 +2609,11 @@ module Google
         # @return [String]
         attr_accessor :order
       
+        # The configuration for how to index a field for search.
+        # Corresponds to the JSON property `searchConfig`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchConfig]
+        attr_accessor :search_config
+      
         # The index configuration to support vector search operations
         # Corresponds to the JSON property `vectorConfig`
         # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1VectorConfig]
@@ -2611,6 +2628,7 @@ module Google
           @array_config = args[:array_config] if args.key?(:array_config)
           @field_path = args[:field_path] if args.key?(:field_path)
           @order = args[:order] if args.key?(:order)
+          @search_config = args[:search_config] if args.key?(:search_config)
           @vector_config = args[:vector_config] if args.key?(:vector_config)
         end
       end
@@ -3028,6 +3046,130 @@ module Google
         end
       end
       
+      # The configuration for how to index a field for search.
+      class GoogleFirestoreAdminV1SearchConfig
+        include Google::Apis::Core::Hashable
+      
+        # The specification for how to build a geo search index for a field.
+        # Corresponds to the JSON property `geoSpec`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchGeoSpec]
+        attr_accessor :geo_spec
+      
+        # The specification for how to build a text search index for a field.
+        # Corresponds to the JSON property `textSpec`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchTextSpec]
+        attr_accessor :text_spec
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @geo_spec = args[:geo_spec] if args.key?(:geo_spec)
+          @text_spec = args[:text_spec] if args.key?(:text_spec)
+        end
+      end
+      
+      # The specification for how to build a geo search index for a field.
+      class GoogleFirestoreAdminV1SearchGeoSpec
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Disables geoJSON indexing for the field. By default, geoJSON points
+        # are indexed.
+        # Corresponds to the JSON property `geoJsonIndexingDisabled`
+        # @return [Boolean]
+        attr_accessor :geo_json_indexing_disabled
+        alias_method :geo_json_indexing_disabled?, :geo_json_indexing_disabled
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @geo_json_indexing_disabled = args[:geo_json_indexing_disabled] if args.key?(:geo_json_indexing_disabled)
+        end
+      end
+      
+      # Options for search indexes at the definition level.
+      class GoogleFirestoreAdminV1SearchIndexOptions
+        include Google::Apis::Core::Hashable
+      
+        # Optional. The language to use for text search indexes. Used as the default
+        # language if not overridden at the document level by specifying the `
+        # text_language_override_field`. The language is specified as a BCP 47 language
+        # code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the
+        # default language is English. For indexes with `ANY_API` ApiScope: If
+        # unspecified, the default behavior is autodetect.
+        # Corresponds to the JSON property `textLanguage`
+        # @return [String]
+        attr_accessor :text_language
+      
+        # Optional. The field in the document that specifies which language to use for
+        # that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if
+        # unspecified, the language is taken from the "language" field if it exists or
+        # from `text_language` if it does not.
+        # Corresponds to the JSON property `textLanguageOverrideFieldPath`
+        # @return [String]
+        attr_accessor :text_language_override_field_path
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @text_language = args[:text_language] if args.key?(:text_language)
+          @text_language_override_field_path = args[:text_language_override_field_path] if args.key?(:text_language_override_field_path)
+        end
+      end
+      
+      # Specification of how the field should be indexed for search text indexes.
+      class GoogleFirestoreAdminV1SearchTextIndexSpec
+        include Google::Apis::Core::Hashable
+      
+        # Required. How to index the text field value.
+        # Corresponds to the JSON property `indexType`
+        # @return [String]
+        attr_accessor :index_type
+      
+        # Required. How to match the text field value.
+        # Corresponds to the JSON property `matchType`
+        # @return [String]
+        attr_accessor :match_type
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @index_type = args[:index_type] if args.key?(:index_type)
+          @match_type = args[:match_type] if args.key?(:match_type)
+        end
+      end
+      
+      # The specification for how to build a text search index for a field.
+      class GoogleFirestoreAdminV1SearchTextSpec
+        include Google::Apis::Core::Hashable
+      
+        # Required. Specifications for how the field should be indexed. Repeated so that
+        # the field can be indexed in multiple ways.
+        # Corresponds to the JSON property `indexSpecs`
+        # @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchTextIndexSpec>]
+        attr_accessor :index_specs
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @index_specs = args[:index_specs] if args.key?(:index_specs)
+        end
+      end
+      
       # The configuration options for using the same encryption method as the source.
       class GoogleFirestoreAdminV1SourceEncryptionOptions
         include Google::Apis::Core::Hashable
@@ -3101,15 +3243,25 @@ module Google
       end
       
       # The TTL (time-to-live) configuration for documents that have this `Field` set.
-      # Storing a timestamp value into a TTL-enabled field will be treated as the
-      # document's absolute expiration time. For Enterprise edition databases, the
-      # timestamp value may also be stored in an array value in the TTL-enabled field.
-      # Timestamp values in the past indicate that the document is eligible for
-      # immediate expiration. Using any other data type or leaving the field absent
-      # will disable expiration for the individual document.
+      # A timestamp stored in a TTL-enabled field will be used to determine the
+      # expiration time of the document. The expiration time is the sum of the
+      # timestamp value and the `expiration_offset`. For Enterprise edition databases,
+      # the timestamp value may alternatively be stored in an array value in the TTL-
+      # enabled field. An expiration time in the past indicates that the document is
+      # eligible for immediate expiration. Using any other data type or leaving the
+      # field absent will disable expiration for the individual document.
       class GoogleFirestoreAdminV1TtlConfig
         include Google::Apis::Core::Hashable
       
+        # Optional. The offset, relative to the timestamp value from the TTL-enabled
+        # field, used to determine the document's expiration time. `expiration_offset.
+        # seconds` must be between 0 and 2,147,483,647 inclusive. Values more precise
+        # than seconds are rejected. If unset, defaults to 0, in which case the
+        # expiration time is the same as the timestamp value from the TTL-enabled field.
+        # Corresponds to the JSON property `expirationOffset`
+        # @return [String]
+        attr_accessor :expiration_offset
+      
         # Output only. The state of the TTL configuration.
         # Corresponds to the JSON property `state`
         # @return [String]
@@ -3121,6 +3273,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @expiration_offset = args[:expiration_offset] if args.key?(:expiration_offset)
           @state = args[:state] if args.key?(:state)
         end
       end
@@ -3134,6 +3287,12 @@ module Google
         # @return [String]
         attr_accessor :change_type
       
+        # The offset, relative to the timestamp value in the TTL-enabled field, used
+        # determine the document's expiration time.
+        # Corresponds to the JSON property `expirationOffset`
+        # @return [String]
+        attr_accessor :expiration_offset
+      
         def initialize(**args)
            update!(**args)
         end
@@ -3141,6 +3300,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @change_type = args[:change_type] if args.key?(:change_type)
+          @expiration_offset = args[:expiration_offset] if args.key?(:expiration_offset)
         end
       end
       
@@ -3922,11 +4082,18 @@ module Google
       end
       
       # Options for a transaction that can be used to read and write documents.
-      # Firestore does not allow 3rd party auth requests to create read-write.
-      # transactions.
       class ReadWrite
         include Google::Apis::Core::Hashable
       
+        # Optional. The concurrency control mode to use for this transaction. A database
+        # is able to use different concurrency modes for different transactions
+        # simultaneously. 3rd party auth requests are only allowed to create optimistic
+        # read-write transactions and must specify that here even if the database-level
+        # setting is already configured to optimistic.
+        # Corresponds to the JSON property `concurrencyMode`
+        # @return [String]
+        attr_accessor :concurrency_mode
+      
         # An optional transaction to retry.
         # Corresponds to the JSON property `retryTransaction`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
@@ -3939,6 +4106,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
           @retry_transaction = args[:retry_transaction] if args.key?(:retry_transaction)
         end
       end
@@ -4561,8 +4729,6 @@ module Google
         attr_accessor :read_only
       
         # Options for a transaction that can be used to read and write documents.
-        # Firestore does not allow 3rd party auth requests to create read-write.
-        # transactions.
         # Corresponds to the JSON property `readWrite`
         # @return [Google::Apis::FirestoreV1::ReadWrite]
         attr_accessor :read_write

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.91.0"
+      GEM_VERSION = "0.93.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.18.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20260304"
+      REVISION = "20260427"
     end
   end
 end

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

@@ -514,6 +514,36 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1SearchConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1SearchGeoSpec
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1SearchIndexOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1SearchTextIndexSpec
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleFirestoreAdminV1SearchTextSpec
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1SourceEncryptionOptions
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1476,6 +1506,8 @@ module Google
           property :multikey, as: 'multikey'
           property :name, as: 'name'
           property :query_scope, as: 'queryScope'
+          property :search_index_options, as: 'searchIndexOptions', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchIndexOptions, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchIndexOptions::Representation
+      
           property :shard_count, as: 'shardCount'
           property :state, as: 'state'
           property :unique, as: 'unique'
@@ -1508,6 +1540,8 @@ module Google
           property :array_config, as: 'arrayConfig'
           property :field_path, as: 'fieldPath'
           property :order, as: 'order'
+          property :search_config, as: 'searchConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchConfig::Representation
+      
           property :vector_config, as: 'vectorConfig', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1VectorConfig, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1VectorConfig::Representation
       
         end
@@ -1639,6 +1673,47 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1SearchConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :geo_spec, as: 'geoSpec', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchGeoSpec, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchGeoSpec::Representation
+      
+          property :text_spec, as: 'textSpec', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchTextSpec, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchTextSpec::Representation
+      
+        end
+      end
+      
+      class GoogleFirestoreAdminV1SearchGeoSpec
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :geo_json_indexing_disabled, as: 'geoJsonIndexingDisabled'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1SearchIndexOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :text_language, as: 'textLanguage'
+          property :text_language_override_field_path, as: 'textLanguageOverrideFieldPath'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1SearchTextIndexSpec
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :index_type, as: 'indexType'
+          property :match_type, as: 'matchType'
+        end
+      end
+      
+      class GoogleFirestoreAdminV1SearchTextSpec
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :index_specs, as: 'indexSpecs', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchTextIndexSpec, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1SearchTextIndexSpec::Representation
+      
+        end
+      end
+      
       class GoogleFirestoreAdminV1SourceEncryptionOptions
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1666,6 +1741,7 @@ module Google
       class GoogleFirestoreAdminV1TtlConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :expiration_offset, as: 'expirationOffset'
           property :state, as: 'state'
         end
       end
@@ -1674,6 +1750,7 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :change_type, as: 'changeType'
+          property :expiration_offset, as: 'expirationOffset'
         end
       end
       
@@ -1908,6 +1985,7 @@ module Google
       class ReadWrite
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :concurrency_mode, as: 'concurrencyMode'
           property :retry_transaction, :base64 => true, as: 'retryTransaction'
         end
       end

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

@@ -1256,7 +1256,8 @@ module Google
         # @param [String] parent
         #   Required. The parent document. In the format: `projects/`project_id`/databases/
         #   `database_id`/documents/`document_path``. For example: `projects/my-project/
-        #   databases/my-database/documents/chatrooms/my-chatroom`
+        #   databases/my-database/documents/chatrooms/my-chatroom` Use `projects/`
+        #   project_id`/databases/`database_id`/documents` to list top-level collections.
         # @param [Google::Apis::FirestoreV1::ListCollectionIdsRequest] list_collection_ids_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -2052,15 +2053,20 @@ module Google
         end
         
         # Lists information about the supported locations for this service. This method
-        # can be called in two ways: * **List all public locations:** Use the path `GET /
-        # v1/locations`. * **List project-visible locations:** Use the path `GET /v1/
-        # projects/`project_id`/locations`. This may include public locations as well as
-        # private or other locations specifically visible to the project.
+        # lists locations based on the resource scope provided in the
+        # ListLocationsRequest.name field: * **Global locations**: If `name` is empty,
+        # the method lists the public locations available to all projects. * **Project-
+        # specific locations**: If `name` follows the format `projects/`project``, the
+        # method lists locations visible to that specific project. This includes public,
+        # private, or other project-specific locations enabled for the project. For gRPC
+        # and client library implementations, the resource name is passed as the `name`
+        # field. For direct service calls, the resource name is incorporated into the
+        # request path based on the specific service implementation and version.
         # @param [String] name
         #   The resource that owns the locations collection, if applicable.
         # @param [Array<String>, String] extra_location_types
-        #   Optional. Do not use this field. It is unsupported and is ignored unless
-        #   explicitly documented otherwise. This is primarily for internal usage.
+        #   Optional. Do not use this field unless explicitly documented otherwise. This
+        #   is primarily for internal usage.
         # @param [String] filter
         #   A filter to narrow down results to a preferred subset. The filtering language
         #   accepts strings like `"displayName=tokyo"`, and is documented in more detail

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.91.0
+  version: 0.93.0
 platform: ruby
 authors:
 - Google LLC
@@ -57,7 +57,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.91.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.93.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 rdoc_options: []
 require_paths: