google-cloud-firestore-v1 2.2.1 → 2.4.0

data/proto_docs/google/api/routing.rb

@@ -49,9 +49,13 @@ module Google
     #       app_profile_id: profiles/prof_qux
     #     }
     #
-    # The routing header consists of one or multiple key-value pairs. Every key
-    # and value must be percent-encoded, and joined together in the format of
-    # `key1=value1&key2=value2`.
+    # The routing header consists of one or multiple key-value pairs. The order of
+    # the key-value pairs is undefined, the order of the `routing_parameters` in
+    # the `RoutingRule` only matters for the evaluation order of the path
+    # templates when `field` is the same. See the examples below for more details.
+    #
+    # Every key and value in the routing header must be percent-encoded,
+    # and joined together in the following format: `key1=value1&key2=value2`.
     # The examples below skip the percent-encoding for readability.
     #
     # Example 1

data/proto_docs/google/firestore/v1/common.rb

@@ -71,12 +71,19 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
           # 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.
           # @!attribute [rw] retry_transaction
           #   @return [::String]
           #     An optional transaction to retry.
+          # @!attribute [rw] concurrency_mode
+          #   @return [::Google::Cloud::Firestore::V1::TransactionOptions::ConcurrencyMode]
+          #     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.
           class ReadWrite
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -94,6 +101,18 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # The type of concurrency control mode for transactions.
+          module ConcurrencyMode
+            # Start the transaction with the database-level default concurrency mode.
+            CONCURRENCY_MODE_UNSPECIFIED = 0
+
+            # Use optimistic concurrency control for the new transaction.
+            OPTIMISTIC = 1
+
+            # Use pessimistic concurrency control for the new transaction.
+            PESSIMISTIC = 2
+          end
         end
       end
     end

data/proto_docs/google/firestore/v1/document.rb

@@ -87,22 +87,22 @@ module Google
         #   @return [::Google::Protobuf::NullValue]
         #     A null value.
         #
-        #     Note: The following fields are mutually exclusive: `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] boolean_value
         #   @return [::Boolean]
         #     A boolean value.
         #
-        #     Note: The following fields are mutually exclusive: `boolean_value`, `null_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `boolean_value`, `null_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] integer_value
         #   @return [::Integer]
         #     An integer value.
         #
-        #     Note: The following fields are mutually exclusive: `integer_value`, `null_value`, `boolean_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `integer_value`, `null_value`, `boolean_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] double_value
         #   @return [::Float]
         #     A double value.
         #
-        #     Note: The following fields are mutually exclusive: `double_value`, `null_value`, `boolean_value`, `integer_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `double_value`, `null_value`, `boolean_value`, `integer_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] timestamp_value
         #   @return [::Google::Protobuf::Timestamp]
         #     A timestamp value.
@@ -110,7 +110,7 @@ module Google
         #     Precise only to microseconds. When stored, any additional precision is
         #     rounded down.
         #
-        #     Note: The following fields are mutually exclusive: `timestamp_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `timestamp_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] string_value
         #   @return [::String]
         #     A string value.
@@ -119,7 +119,7 @@ module Google
         #     Only the first 1,500 bytes of the UTF-8 representation are considered by
         #     queries.
         #
-        #     Note: The following fields are mutually exclusive: `string_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `string_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] bytes_value
         #   @return [::String]
         #     A bytes value.
@@ -127,18 +127,18 @@ module Google
         #     Must not exceed 1 MiB - 89 bytes.
         #     Only the first 1,500 bytes are considered by queries.
         #
-        #     Note: The following fields are mutually exclusive: `bytes_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `bytes_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] reference_value
         #   @return [::String]
         #     A reference to a document. For example:
         #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
         #
-        #     Note: The following fields are mutually exclusive: `reference_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `reference_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] geo_point_value
         #   @return [::Google::Type::LatLng]
         #     A geo point value representing a point on the surface of Earth.
         #
-        #     Note: The following fields are mutually exclusive: `geo_point_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `geo_point_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] array_value
         #   @return [::Google::Cloud::Firestore::V1::ArrayValue]
         #     An array value.
@@ -146,12 +146,53 @@ module Google
         #     Cannot directly contain another array value, though can contain a
         #     map which contains another array.
         #
-        #     Note: The following fields are mutually exclusive: `array_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `array_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] map_value
         #   @return [::Google::Cloud::Firestore::V1::MapValue]
         #     A map value.
         #
-        #     Note: The following fields are mutually exclusive: `map_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `map_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `field_reference_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] field_reference_value
+        #   @return [::String]
+        #     Value which references a field.
+        #
+        #     This is considered relative (vs absolute) since it only refers to a field
+        #     and not a field within a particular document.
+        #
+        #     **Requires:**
+        #
+        #     * Must follow [field reference][FieldReference.field_path] limitations.
+        #
+        #     * Not allowed to be used when writing documents.
+        #
+        #     Note: The following fields are mutually exclusive: `field_reference_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `variable_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] variable_reference_value
+        #   @return [::String]
+        #     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.
+        #
+        #     Note: The following fields are mutually exclusive: `variable_reference_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `function_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] function_value
+        #   @return [::Google::Cloud::Firestore::V1::Function]
+        #     A value that represents an unevaluated expression.
+        #
+        #     **Requires:**
+        #
+        #     * Not allowed to be used when writing documents.
+        #
+        #     Note: The following fields are mutually exclusive: `function_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `pipeline_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] pipeline_value
+        #   @return [::Google::Cloud::Firestore::V1::Pipeline]
+        #     A value that represents an unevaluated pipeline.
+        #
+        #     **Requires:**
+        #
+        #     * Not allowed to be used when writing documents.
+        #
+        #     Note: The following fields are mutually exclusive: `pipeline_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`, `field_reference_value`, `variable_reference_value`, `function_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class Value
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -188,6 +229,97 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
         end
+
+        # Represents an unevaluated scalar expression.
+        #
+        # For example, the expression `like(user_name, "%alice%")` is represented as:
+        #
+        # ```
+        # name: "like"
+        # args { field_reference: "user_name" }
+        # args { string_value: "%alice%" }
+        # ```
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the function to evaluate.
+        #
+        #     **Requires:**
+        #
+        #     * must be in snake case (lower case with underscore separator).
+        # @!attribute [rw] args
+        #   @return [::Array<::Google::Cloud::Firestore::V1::Value>]
+        #     Optional. Ordered list of arguments the given function expects.
+        # @!attribute [rw] options
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}]
+        #     Optional. Optional named arguments that certain functions may support.
+        class Function
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Firestore::V1::Value]
+          class OptionsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A Firestore query represented as an ordered list of operations / stages.
+        # @!attribute [rw] stages
+        #   @return [::Array<::Google::Cloud::Firestore::V1::Pipeline::Stage>]
+        #     Required. Ordered list of stages to evaluate.
+        class Pipeline
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A single operation within a pipeline.
+          #
+          # A stage is made up of a unique name, and a list of arguments. The exact
+          # number of arguments & types is dependent on the stage type.
+          #
+          # To give an example, the stage `filter(state = "MD")` would be encoded as:
+          #
+          # ```
+          # name: "filter"
+          # args {
+          #   function_value {
+          #     name: "eq"
+          #     args { field_reference_value: "state" }
+          #     args { string_value: "MD" }
+          #   }
+          # }
+          # ```
+          #
+          # See public documentation for the full list.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the stage to evaluate.
+          #
+          #     **Requires:**
+          #
+          #     * must be in snake case (lower case with underscore separator).
+          # @!attribute [rw] args
+          #   @return [::Array<::Google::Cloud::Firestore::V1::Value>]
+          #     Optional. Ordered list of arguments the given stage expects.
+          # @!attribute [rw] options
+          #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}]
+          #     Optional. Optional named arguments that certain functions may support.
+          class Stage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::Google::Cloud::Firestore::V1::Value]
+            class OptionsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
       end
     end
   end

data/proto_docs/google/firestore/v1/explain_stats.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Firestore
+      module V1
+        # Pipeline explain stats.
+        #
+        # Depending on the explain options in the original request, this can contain
+        # the optimized plan and / or execution stats.
+        # @!attribute [rw] data
+        #   @return [::Google::Protobuf::Any]
+        #     The format depends on the `output_format` options in the request.
+        #
+        #     Currently there are two supported options: `TEXT` and `JSON`.
+        #     Both supply a `google.protobuf.StringValue`.
+        class ExplainStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/firestore/v1/firestore.rb

@@ -449,6 +449,97 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The request for
+        # {::Google::Cloud::Firestore::V1::Firestore::Client#execute_pipeline Firestore.ExecutePipeline}.
+        # @!attribute [rw] database
+        #   @return [::String]
+        #     Required. Database identifier, in the form
+        #     `projects/{project}/databases/{database}`.
+        # @!attribute [rw] structured_pipeline
+        #   @return [::Google::Cloud::Firestore::V1::StructuredPipeline]
+        #     A pipelined operation.
+        # @!attribute [rw] transaction
+        #   @return [::String]
+        #     Run the query within an already active transaction.
+        #
+        #     The value here is the opaque transaction ID to execute the query in.
+        #
+        #     Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] new_transaction
+        #   @return [::Google::Cloud::Firestore::V1::TransactionOptions]
+        #     Execute the pipeline in a new transaction.
+        #
+        #     The identifier of the newly created transaction will be returned in the
+        #     first response on the stream. This defaults to a read-only transaction.
+        #
+        #     Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Execute the pipeline in a snapshot transaction at the given time.
+        #
+        #     This must be a microsecond precision timestamp within the past one hour,
+        #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+        #     minute timestamp within the past 7 days.
+        #
+        #     Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] auto_commit_transaction
+        #   @return [::Boolean]
+        #     Optional. Automatically commits the transaction after the pipeline has been
+        #     executed. Only permitted in combination with `transaction` or
+        #     `new_transaction`.
+        class ExecutePipelineRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for [Firestore.Execute][].
+        # @!attribute [rw] transaction
+        #   @return [::String]
+        #     Newly created transaction identifier.
+        #
+        #     This field is only specified as part of the first response from the server,
+        #     alongside the `results` field when the original request specified
+        #     [ExecuteRequest.new_transaction][].
+        # @!attribute [rw] results
+        #   @return [::Array<::Google::Cloud::Firestore::V1::Document>]
+        #     An ordered batch of results returned executing a pipeline.
+        #
+        #     The batch size is variable, and can even be zero for when only a partial
+        #     progress message is returned.
+        #
+        #     The fields present in the returned documents are only those that were
+        #     explicitly requested in the pipeline, this includes those like
+        #     {::Google::Cloud::Firestore::V1::Document#name `__name__`} and
+        #     {::Google::Cloud::Firestore::V1::Document#update_time `__update_time__`}. This is
+        #     explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument`
+        #     RPCs which always return such fields even when they are not specified in
+        #     the {::Google::Cloud::Firestore::V1::DocumentMask `mask`}.
+        # @!attribute [rw] execution_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The time at which the results are valid.
+        #
+        #     This is a (not strictly) monotonically increasing value across multiple
+        #     responses in the same stream. The API guarantees that all previously
+        #     returned results are still valid at the latest `execution_time`. This
+        #     allows the API consumer to treat the query if it ran at the latest
+        #     `execution_time` returned.
+        #
+        #     If the query returns no results, a response with `execution_time` and no
+        #     `results` will be sent, and this represents the time at which the operation
+        #     was run.
+        # @!attribute [rw] explain_stats
+        #   @return [::Google::Cloud::Firestore::V1::ExplainStats]
+        #     Query explain stats.
+        #
+        #     This is present on the **last** response if the request configured explain
+        #     to run in 'analyze' or 'explain' mode in the pipeline options. If the query
+        #     does not return any results, a response with `explain_stats` and no
+        #     `results` will still be sent.
+        class ExecutePipelineResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The request for
         # {::Google::Cloud::Firestore::V1::Firestore::Client#run_aggregation_query Firestore.RunAggregationQuery}.
         # @!attribute [rw] parent
@@ -813,7 +904,7 @@ module Google
         #     will immediately send a response with a `TargetChange::Remove` event.
         #
         #     Note that if the client sends multiple `AddTarget` requests
-        #     without an ID, the order of IDs returned in `TargetChage.target_ids` are
+        #     without an ID, the order of IDs returned in `TargetChange.target_ids` are
         #     undefined. Therefore, clients should provide a target ID instead of relying
         #     on the server to assign one.
         #
@@ -938,6 +1029,9 @@ module Google
         #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
         #     For example:
         #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
+        #
+        #     Use `projects/{project_id}/databases/{database_id}/documents` to list
+        #     top-level collections.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     The maximum number of results to return.

data/proto_docs/google/firestore/v1/pipeline.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Firestore
+      module V1
+        # A Firestore query represented as an ordered list of operations / stages.
+        #
+        # This is considered the top-level function which plans and executes a query.
+        # It is logically equivalent to `query(stages, options)`, but prevents the
+        # client from having to build a function wrapper.
+        # @!attribute [rw] pipeline
+        #   @return [::Google::Cloud::Firestore::V1::Pipeline]
+        #     Required. The pipeline query to execute.
+        # @!attribute [rw] options
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Firestore::V1::Value}]
+        #     Optional. Optional query-level arguments.
+        class StructuredPipeline
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Firestore::V1::Value]
+          class OptionsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/firestore/v1/query.rb

@@ -48,9 +48,12 @@ module Google
         #   @return [::Array<::Google::Cloud::Firestore::V1::StructuredQuery::Order>]
         #     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:
+        #     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.
@@ -66,6 +69,13 @@ module Google
         #      * `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__`.
         # @!attribute [rw] start_at
         #   @return [::Google::Cloud::Firestore::V1::Cursor]
         #     A potential prefix of a position in the result set to start the query at.
@@ -409,8 +419,8 @@ module Google
           #     Since DOT_PRODUCT distances increase when the vectors are more similar,
           #     the comparison is inverted.
           #
-          #     * For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold
-          #     * For DOT_PRODUCT:       WHERE distance >= distance_threshold
+          #     * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold`
+          #     * For DOT_PRODUCT:       `WHERE distance >= distance_threshold`
           class FindNearest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/wrappers.rb

@@ -22,6 +22,9 @@ module Google
     # Wrapper message for `double`.
     #
     # The JSON representation for `DoubleValue` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Float]
     #     The double value.
@@ -33,6 +36,9 @@ module Google
     # Wrapper message for `float`.
     #
     # The JSON representation for `FloatValue` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Float]
     #     The float value.
@@ -44,6 +50,9 @@ module Google
     # Wrapper message for `int64`.
     #
     # The JSON representation for `Int64Value` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The int64 value.
@@ -55,6 +64,9 @@ module Google
     # Wrapper message for `uint64`.
     #
     # The JSON representation for `UInt64Value` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The uint64 value.
@@ -66,6 +78,9 @@ module Google
     # Wrapper message for `int32`.
     #
     # The JSON representation for `Int32Value` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The int32 value.
@@ -77,6 +92,9 @@ module Google
     # Wrapper message for `uint32`.
     #
     # The JSON representation for `UInt32Value` is JSON number.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Integer]
     #     The uint32 value.
@@ -88,6 +106,9 @@ module Google
     # Wrapper message for `bool`.
     #
     # The JSON representation for `BoolValue` is JSON `true` and `false`.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::Boolean]
     #     The bool value.
@@ -99,6 +120,9 @@ module Google
     # Wrapper message for `string`.
     #
     # The JSON representation for `StringValue` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::String]
     #     The string value.
@@ -110,6 +134,9 @@ module Google
     # Wrapper message for `bytes`.
     #
     # The JSON representation for `BytesValue` is JSON string.
+    #
+    # Not recommended for use in new APIs, but still useful for legacy APIs and
+    # has no plan to be removed.
     # @!attribute [rw] value
     #   @return [::String]
     #     The bytes value.

data/proto_docs/google/type/latlng.rb

@@ -21,9 +21,9 @@ module Google
   module Type
     # An object that represents a latitude/longitude pair. This is expressed as a
     # pair of doubles to represent degrees latitude and degrees longitude. Unless
-    # specified otherwise, this must conform to the
-    # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
-    # standard</a>. Values must be within normalized ranges.
+    # specified otherwise, this object must conform to the
+    # <a href="https://en.wikipedia.org/wiki/World_Geodetic_System#1984_version">
+    # WGS84 standard</a>. Values must be within normalized ranges.
     # @!attribute [rw] latitude
     #   @return [::Float]
     #     The latitude in degrees. It must be in the range [-90.0, +90.0].