google-apis-firestore_v1 0.90.0 → 0.92.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2eaddcade267ac8be66501aa1459965bd1bfa8dc40c8517af8561c75acb0c68
-  data.tar.gz: 8c9c614351a03357c2c5045b5d34e70c9ab4a42deebd59ad365a6468ac5fff52
+  metadata.gz: e36f990c486cd2a63bfbd67eb0ed1b0f6e42b8d3ae12ba7f2930b13c49039652
+  data.tar.gz: 93ccdf495f46a96a196829c29f810067e3b12bad276b64b866fa88026d010f6f
 SHA512:
-  metadata.gz: 4f3ea1773af11a7913552327cf3fb2701a7440b95501caf50d6aa147709594fb3842ef4592c6caecb66a8d17e63fb076641306e6a4e8e8839e2c65417f28b3da
-  data.tar.gz: 93e65c9aaf93490c96dd1227fa3687eeb5828e342f36ac3f55fe8585b6075a0b4df43db26ebce666472920a36bed1c912e5fcd5d946bc827dd4fb98c82425980
+  metadata.gz: 1def5d0f60ce94ccba5b592b0b40dc70080a71e8d32ccb12659c21ade94457fd65fa48e1585fa199ad4eef80ceb4263f7971aa4638a1128ab6e47dd8bcde604f
+  data.tar.gz: 725d9a1451a9b42a6e7cc02f26c19040e6e61cf0a456752fb228490b53ba13b5db93f73697232ec0d50317592ca0eb266543bc9ffc4e7ad0889499bd59e6e89b

data/CHANGELOG.md

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

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

@@ -1834,8 +1834,8 @@ module Google
         # @return [String]
         attr_accessor :key_prefix
       
-        # The location of the database. Available locations are listed at https://cloud.
-        # google.com/firestore/docs/locations.
+        # Required. The location of the database. Available locations are listed at
+        # https://cloud.google.com/firestore/docs/locations.
         # Corresponds to the JSON property `locationId`
         # @return [String]
         attr_accessor :location_id
@@ -1882,8 +1882,8 @@ module Google
         # @return [Hash<String,String>]
         attr_accessor :tags
       
-        # The type of the database. See https://cloud.google.com/datastore/docs/
-        # firestore-or-datastore for information about how to choose.
+        # Required. 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`
         # @return [String]
         attr_accessor :type
@@ -2191,12 +2191,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 +2468,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 +2502,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 +2604,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 +2623,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 +3041,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 +3238,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 +3268,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 +3282,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 +3295,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
       
@@ -4334,19 +4489,25 @@ module Google
         # @return [Fixnum]
         attr_accessor :offset
       
-        # The order to apply to the query results. Firestore allows callers to provide a
-        # full ordering, a partial ordering, or no ordering at all. In all cases,
-        # Firestore guarantees a stable ordering through the following rules: * The `
-        # order_by` is required to reference all fields used with an inequality filter. *
-        # All fields that are required to be in the `order_by` but are not already
-        # present are appended in lexicographical ordering of the field name. * If an
-        # order on `__name__` is not specified, it is appended by default. Fields are
-        # appended with the same sort direction as the last order specified, or '
-        # ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `
-        # ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC,
-        # __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__
-        # ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a >
-        # 1 ORDER BY a ASC, __name__ ASC`
+        # The order to apply to the query results. Callers can provide a full ordering,
+        # a partial ordering, or no ordering at all. While Firestore will always respect
+        # the provided order, the behavior for queries without a full ordering is
+        # different per database edition: In Standard edition, Firestore guarantees a
+        # stable ordering through the following rules: * The `order_by` is required to
+        # reference all fields used with an inequality filter. * All fields that are
+        # required to be in the `order_by` but are not already present are appended in
+        # lexicographical ordering of the field name. * If an order on `__name__` is not
+        # specified, it is appended by default. Fields are appended with the same sort
+        # direction as the last order specified, or 'ASCENDING' if no order was
+        # specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` *
+        # `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1`
+        # becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND
+        # a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
+        # In Enterprise edition, Firestore does not guarantee a stable ordering. Instead
+        # it will pick the most efficient ordering based on the indexes available at the
+        # time of query execution. This will result in a different ordering for queries
+        # that are otherwise identical. To ensure a stable ordering, always include a
+        # unique field in the `order_by` clause, such as `__name__`.
         # Corresponds to the JSON property `orderBy`
         # @return [Array<Google::Apis::FirestoreV1::Order>]
         attr_accessor :order_by
@@ -4686,6 +4847,13 @@ module Google
         # @return [String]
         attr_accessor :timestamp_value
       
+        # Pointer to a variable defined elsewhere in a pipeline. Unlike `
+        # field_reference_value` which references a field within a document, this refers
+        # to a variable, defined in a separate namespace than the fields of a document.
+        # Corresponds to the JSON property `variableReferenceValue`
+        # @return [String]
+        attr_accessor :variable_reference_value
+      
         def initialize(**args)
            update!(**args)
         end
@@ -4706,6 +4874,7 @@ module Google
           @reference_value = args[:reference_value] if args.key?(:reference_value)
           @string_value = args[:string_value] if args.key?(:string_value)
           @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value)
+          @variable_reference_value = args[:variable_reference_value] if args.key?(:variable_reference_value)
         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.90.0"
+      GEM_VERSION = "0.92.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 = "20260212"
+      REVISION = "20260405"
     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
       
@@ -2111,6 +2188,7 @@ module Google
           property :reference_value, as: 'referenceValue'
           property :string_value, as: 'stringValue'
           property :timestamp_value, as: 'timestampValue'
+          property :variable_reference_value, as: 'variableReferenceValue'
         end
       end
       

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

@@ -2052,10 +2052,15 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.90.0
+  version: 0.92.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.90.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.92.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 rdoc_options: []
 require_paths: