google-cloud-firestore-v1 2.3.0 → 2.6.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -47,6 +47,9 @@ module Google
         #     minute timestamp within the past 7 days.
         #
         #     Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class GetDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -123,6 +126,9 @@ module Google
         #     {::Google::Cloud::Firestore::V1::Document#update_time `update_time`} set.
         #
         #     Requests with `show_missing` may not specify `where` or `order_by`.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class ListDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -168,6 +174,9 @@ module Google
         #
         #     If the document has a field that is not present in this mask, that field
         #     will not be returned in the response.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class CreateDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -198,6 +207,9 @@ module Google
         #   @return [::Google::Cloud::Firestore::V1::Precondition]
         #     An optional precondition on the document.
         #     The request will fail if this is set and not met by the target document.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class UpdateDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -213,6 +225,9 @@ module Google
         #   @return [::Google::Cloud::Firestore::V1::Precondition]
         #     An optional precondition on the document.
         #     The request will fail if this is set and not met by the target document.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class DeleteDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -258,6 +273,9 @@ module Google
         #     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] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class BatchGetDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -303,6 +321,9 @@ module Google
         #   @return [::Google::Cloud::Firestore::V1::TransactionOptions]
         #     The options for the transaction.
         #     Defaults to a read-write transaction.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class BeginTransactionRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -331,6 +352,9 @@ module Google
         # @!attribute [rw] transaction
         #   @return [::String]
         #     If set, applies all writes in this transaction, and commits it.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class CommitRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -360,6 +384,9 @@ module Google
         # @!attribute [rw] transaction
         #   @return [::String]
         #     Required. The transaction to roll back.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class RollbackRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -405,6 +432,9 @@ module Google
         #   @return [::Google::Cloud::Firestore::V1::ExplainOptions]
         #     Optional. Explain options for the query. If set, additional query
         #     statistics will be returned. If not, only query results will be returned.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class RunQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -482,6 +512,14 @@ module Google
         #     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`.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class ExecutePipelineRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -576,6 +614,9 @@ module Google
         #   @return [::Google::Cloud::Firestore::V1::ExplainOptions]
         #     Optional. Explain options for the query. If set, additional query
         #     statistics will be returned. If not, only query results will be returned.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class RunAggregationQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -669,6 +710,9 @@ module Google
         #     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.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class PartitionQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -752,6 +796,9 @@ module Google
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels associated with this write request.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class WriteRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -810,6 +857,9 @@ module Google
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels associated with this target change.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class ListenRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1024,6 +1074,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.
@@ -1038,6 +1091,9 @@ module Google
         #     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.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class ListCollectionIdsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1072,6 +1128,9 @@ module Google
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels associated with this batch write.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Firestore::V1::RequestOptions]
+        #     Optional. Any additional options for the request.
         class BatchWriteRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2025 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2024 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/proto_docs/google/protobuf/any.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/proto_docs/google/protobuf/duration.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2022 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/proto_docs/google/protobuf/empty.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/proto_docs/google/protobuf/struct.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/proto_docs/google/protobuf/timestamp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -110,14 +110,15 @@ module Google
     # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [::Integer]
-    #     Represents seconds of UTC time since Unix epoch
-    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
-    #     9999-12-31T23:59:59Z inclusive.
+    #     Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must
+    #     be between -315576000000 and 315576000000 inclusive (which corresponds to
+    #     0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
     # @!attribute [rw] nanos
     #   @return [::Integer]
-    #     Non-negative fractions of a second at nanosecond resolution. Negative
-    #     second values with fractions must still have non-negative nanos values
-    #     that count forward in time. Must be from 0 to 999,999,999
+    #     Non-negative fractions of a second at nanosecond resolution. This field is
+    #     the nanosecond portion of the duration, not an alternative to seconds.
+    #     Negative second values with fractions must still have non-negative nanos
+    #     values that count forward in time. Must be between 0 and 999,999,999
     #     inclusive.
     class Timestamp
       include ::Google::Protobuf::MessageExts

data/proto_docs/google/protobuf/wrappers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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/rpc/status.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/proto_docs/google/type/latlng.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2020 Google LLC
+# Copyright 2026 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -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].

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-v1
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Google LLC
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -51,8 +51,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Cloud Firestore is a NoSQL document database built for automatic scaling,
-  high performance, and ease of application development. Note that google-cloud-firestore-v1
+description: Accesses the NoSQL document database built for automatic scaling, high
+  performance, and ease of application development. Note that google-cloud-firestore-v1
   is a version-specific client library. For most uses, we recommend installing the
   main client library google-cloud-firestore instead. See the readme for more details.
 email: googleapis-packages@google.com
@@ -120,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="