google-cloud-firestore-v1 1.1.1 → 1.3.0

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

@@ -36,6 +36,8 @@ module Google
         # @!attribute [rw] transaction
         #   @return [::String]
         #     Reads the document in a transaction.
+        #
+        #     Note: The following fields are mutually exclusive: `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]
         #     Reads the version of the document at the given time.
@@ -43,6 +45,8 @@ 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.
+        #
+        #     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.
         class GetDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -97,6 +101,8 @@ module Google
         # @!attribute [rw] transaction
         #   @return [::String]
         #     Perform the read as part of an already active transaction.
+        #
+        #     Note: The following fields are mutually exclusive: `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]
         #     Perform the read at the provided time.
@@ -104,6 +110,8 @@ 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.
+        #
+        #     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] show_missing
         #   @return [::Boolean]
         #     If the list should show missing documents.
@@ -231,12 +239,16 @@ module Google
         # @!attribute [rw] transaction
         #   @return [::String]
         #     Reads documents in a transaction.
+        #
+        #     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]
         #     Starts a new transaction and reads the documents.
         #     Defaults to a read-only transaction.
         #     The new transaction ID will be returned as the first response in the
         #     stream.
+        #
+        #     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]
         #     Reads documents as they were at the given time.
@@ -244,6 +256,8 @@ 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.
+        #
+        #     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.
         class BatchGetDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -254,10 +268,14 @@ module Google
         # @!attribute [rw] found
         #   @return [::Google::Cloud::Firestore::V1::Document]
         #     A document that was requested.
+        #
+        #     Note: The following fields are mutually exclusive: `found`, `missing`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] missing
         #   @return [::String]
         #     A document name that was requested but does not exist. In the format:
         #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
+        #
+        #     Note: The following fields are mutually exclusive: `missing`, `found`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     The transaction that was started as part of this request.
@@ -364,12 +382,16 @@ module Google
         #     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]
         #     Starts a new transaction and reads the documents.
         #     Defaults to a read-only transaction.
         #     The new transaction ID will be returned as the first response in the
         #     stream.
+        #
+        #     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]
         #     Reads documents as they were at the given time.
@@ -377,6 +399,8 @@ 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.
+        #
+        #     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] explain_options
         #   @return [::Google::Cloud::Firestore::V1::ExplainOptions]
         #     Optional. Explain options for the query. If set, additional query
@@ -443,12 +467,16 @@ module Google
         #     Run the aggregation 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]
         #     Starts a new transaction as part of the query, defaulting to read-only.
         #
         #     The new transaction ID will be returned as the first response in the
         #     stream.
+        #
+        #     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]
         #     Executes the query at the given timestamp.
@@ -456,6 +484,8 @@ 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.
+        #
+        #     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] explain_options
         #   @return [::Google::Cloud::Firestore::V1::ExplainOptions]
         #     Optional. Explain options for the query. If set, additional query
@@ -684,9 +714,13 @@ module Google
         # @!attribute [rw] add_target
         #   @return [::Google::Cloud::Firestore::V1::Target]
         #     A target to add to this stream.
+        #
+        #     Note: The following fields are mutually exclusive: `add_target`, `remove_target`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] remove_target
         #   @return [::Integer]
         #     The ID of a target to remove from this stream.
+        #
+        #     Note: The following fields are mutually exclusive: `remove_target`, `add_target`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels associated with this target change.
@@ -708,16 +742,24 @@ module Google
         # @!attribute [rw] target_change
         #   @return [::Google::Cloud::Firestore::V1::TargetChange]
         #     Targets have changed.
+        #
+        #     Note: The following fields are mutually exclusive: `target_change`, `document_change`, `document_delete`, `document_remove`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] document_change
         #   @return [::Google::Cloud::Firestore::V1::DocumentChange]
         #     A {::Google::Cloud::Firestore::V1::Document Document} has changed.
+        #
+        #     Note: The following fields are mutually exclusive: `document_change`, `target_change`, `document_delete`, `document_remove`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] document_delete
         #   @return [::Google::Cloud::Firestore::V1::DocumentDelete]
         #     A {::Google::Cloud::Firestore::V1::Document Document} has been deleted.
+        #
+        #     Note: The following fields are mutually exclusive: `document_delete`, `target_change`, `document_change`, `document_remove`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] document_remove
         #   @return [::Google::Cloud::Firestore::V1::DocumentRemove]
         #     A {::Google::Cloud::Firestore::V1::Document Document} has been removed from a target
         #     (because it is no longer relevant to that target).
+        #
+        #     Note: The following fields are mutually exclusive: `document_remove`, `target_change`, `document_change`, `document_delete`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] filter
         #   @return [::Google::Cloud::Firestore::V1::ExistenceFilter]
         #     A filter to apply to the set of documents previously returned for the
@@ -725,6 +767,8 @@ module Google
         #
         #     Returned when documents may have been removed from the given target, but
         #     the exact documents are unknown.
+        #
+        #     Note: The following fields are mutually exclusive: `filter`, `target_change`, `document_change`, `document_delete`, `document_remove`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         class ListenResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -734,20 +778,28 @@ module Google
         # @!attribute [rw] query
         #   @return [::Google::Cloud::Firestore::V1::Target::QueryTarget]
         #     A target specified by a query.
+        #
+        #     Note: The following fields are mutually exclusive: `query`, `documents`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] documents
         #   @return [::Google::Cloud::Firestore::V1::Target::DocumentsTarget]
         #     A target specified by a set of document names.
+        #
+        #     Note: The following fields are mutually exclusive: `documents`, `query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] resume_token
         #   @return [::String]
         #     A resume token from a prior
         #     {::Google::Cloud::Firestore::V1::TargetChange TargetChange} for an identical target.
         #
         #     Using a resume token with a different target is unsupported and may fail.
+        #
+        #     Note: The following fields are mutually exclusive: `resume_token`, `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]
         #     Start listening after a specific `read_time`.
         #
         #     The client must know the state of matching documents at this time.
+        #
+        #     Note: The following fields are mutually exclusive: `read_time`, `resume_token`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] target_id
         #   @return [::Integer]
         #     The target ID that identifies the target on the stream. Must be a positive

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

@@ -158,12 +158,18 @@ module Google
           # @!attribute [rw] composite_filter
           #   @return [::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter]
           #     A composite filter.
+          #
+          #     Note: The following fields are mutually exclusive: `composite_filter`, `field_filter`, `unary_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] field_filter
           #   @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter]
           #     A filter on a document field.
+          #
+          #     Note: The following fields are mutually exclusive: `field_filter`, `composite_filter`, `unary_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] unary_filter
           #   @return [::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter]
           #     A filter that takes exactly one argument.
+          #
+          #     Note: The following fields are mutually exclusive: `unary_filter`, `composite_filter`, `field_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class Filter
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -470,12 +476,18 @@ module Google
           # @!attribute [rw] count
           #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count]
           #     Count aggregator.
+          #
+          #     Note: The following fields are mutually exclusive: `count`, `sum`, `avg`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] sum
           #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Sum]
           #     Sum aggregator.
+          #
+          #     Note: The following fields are mutually exclusive: `sum`, `count`, `avg`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] avg
           #   @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Avg]
           #     Average aggregator.
+          #
+          #     Note: The following fields are mutually exclusive: `avg`, `count`, `sum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] alias
           #   @return [::String]
           #     Optional. Optional name of the field to store the result of the

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

@@ -25,13 +25,19 @@ module Google
         # @!attribute [rw] update
         #   @return [::Google::Cloud::Firestore::V1::Document]
         #     A document to write.
+        #
+        #     Note: The following fields are mutually exclusive: `update`, `delete`, `transform`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] delete
         #   @return [::String]
         #     A document name to delete. In the format:
         #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
+        #
+        #     Note: The following fields are mutually exclusive: `delete`, `update`, `transform`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] transform
         #   @return [::Google::Cloud::Firestore::V1::DocumentTransform]
         #     Applies a transformation to a document.
+        #
+        #     Note: The following fields are mutually exclusive: `transform`, `update`, `delete`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] update_mask
         #   @return [::Google::Cloud::Firestore::V1::DocumentMask]
         #     The fields to update in this write.
@@ -83,6 +89,8 @@ module Google
           # @!attribute [rw] set_to_server_value
           #   @return [::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform::ServerValue]
           #     Sets the field to the given server value.
+          #
+          #     Note: The following fields are mutually exclusive: `set_to_server_value`, `increment`, `maximum`, `minimum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] increment
           #   @return [::Google::Cloud::Firestore::V1::Value]
           #     Adds the given value to the field's current value.
@@ -95,6 +103,8 @@ module Google
           #     representation of double values follow IEEE 754 semantics.
           #     If there is positive/negative integer overflow, the field is resolved
           #     to the largest magnitude positive/negative integer.
+          #
+          #     Note: The following fields are mutually exclusive: `increment`, `set_to_server_value`, `maximum`, `minimum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] maximum
           #   @return [::Google::Cloud::Firestore::V1::Value]
           #     Sets the field to the maximum of its current value and the given value.
@@ -109,6 +119,8 @@ module Google
           #     0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and
           #     zero input value is always the stored value.
           #     The maximum of any numeric value x and NaN is NaN.
+          #
+          #     Note: The following fields are mutually exclusive: `maximum`, `set_to_server_value`, `increment`, `minimum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] minimum
           #   @return [::Google::Cloud::Firestore::V1::Value]
           #     Sets the field to the minimum of its current value and the given value.
@@ -123,6 +135,8 @@ module Google
           #     0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and
           #     zero input value is always the stored value.
           #     The minimum of any numeric value x and NaN is NaN.
+          #
+          #     Note: The following fields are mutually exclusive: `minimum`, `set_to_server_value`, `increment`, `maximum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] append_missing_elements
           #   @return [::Google::Cloud::Firestore::V1::ArrayValue]
           #     Append the given elements in order if they are not already present in
@@ -137,6 +151,8 @@ module Google
           #     be considered.
           #
           #     The corresponding transform_result will be the null value.
+          #
+          #     Note: The following fields are mutually exclusive: `append_missing_elements`, `set_to_server_value`, `increment`, `maximum`, `minimum`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] remove_all_from_array
           #   @return [::Google::Cloud::Firestore::V1::ArrayValue]
           #     Remove all of the given elements from the array in the field.
@@ -149,6 +165,8 @@ module Google
           #     This will remove all equivalent values if there are duplicates.
           #
           #     The corresponding transform_result will be the null value.
+          #
+          #     Note: The following fields are mutually exclusive: `remove_all_from_array`, `set_to_server_value`, `increment`, `maximum`, `minimum`, `append_missing_elements`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           class FieldTransform
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/struct.rb

@@ -53,21 +53,33 @@ module Google
     # @!attribute [rw] null_value
     #   @return [::Google::Protobuf::NullValue]
     #     Represents a null value.
+    #
+    #     Note: The following fields are mutually exclusive: `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] number_value
     #   @return [::Float]
     #     Represents a double value.
+    #
+    #     Note: The following fields are mutually exclusive: `number_value`, `null_value`, `string_value`, `bool_value`, `struct_value`, `list_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]
     #     Represents a string value.
+    #
+    #     Note: The following fields are mutually exclusive: `string_value`, `null_value`, `number_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] bool_value
     #   @return [::Boolean]
     #     Represents a boolean value.
+    #
+    #     Note: The following fields are mutually exclusive: `bool_value`, `null_value`, `number_value`, `string_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] struct_value
     #   @return [::Google::Protobuf::Struct]
     #     Represents a structured value.
+    #
+    #     Note: The following fields are mutually exclusive: `struct_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
     # @!attribute [rw] list_value
     #   @return [::Google::Protobuf::ListValue]
     #     Represents a repeated `Value`.
+    #
+    #     Note: The following fields are mutually exclusive: `list_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `struct_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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-v1
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.25.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -121,7 +120,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -129,15 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Accesses the NoSQL document database built for automatic scaling, high performance,
   and ease of application development.