google-cloud-firestore-v1 1.0.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -36,6 +36,8 @@ module Google
36
36
  # @!attribute [rw] transaction
37
37
  # @return [::String]
38
38
  # Reads the document in a transaction.
39
+ #
40
+ # 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.
39
41
  # @!attribute [rw] read_time
40
42
  # @return [::Google::Protobuf::Timestamp]
41
43
  # Reads the version of the document at the given time.
@@ -43,6 +45,8 @@ module Google
43
45
  # This must be a microsecond precision timestamp within the past one hour,
44
46
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
45
47
  # minute timestamp within the past 7 days.
48
+ #
49
+ # 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.
46
50
  class GetDocumentRequest
47
51
  include ::Google::Protobuf::MessageExts
48
52
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -97,6 +101,8 @@ module Google
97
101
  # @!attribute [rw] transaction
98
102
  # @return [::String]
99
103
  # Perform the read as part of an already active transaction.
104
+ #
105
+ # 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.
100
106
  # @!attribute [rw] read_time
101
107
  # @return [::Google::Protobuf::Timestamp]
102
108
  # Perform the read at the provided time.
@@ -104,6 +110,8 @@ module Google
104
110
  # This must be a microsecond precision timestamp within the past one hour,
105
111
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
106
112
  # minute timestamp within the past 7 days.
113
+ #
114
+ # 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.
107
115
  # @!attribute [rw] show_missing
108
116
  # @return [::Boolean]
109
117
  # If the list should show missing documents.
@@ -231,12 +239,16 @@ module Google
231
239
  # @!attribute [rw] transaction
232
240
  # @return [::String]
233
241
  # Reads documents in a transaction.
242
+ #
243
+ # 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.
234
244
  # @!attribute [rw] new_transaction
235
245
  # @return [::Google::Cloud::Firestore::V1::TransactionOptions]
236
246
  # Starts a new transaction and reads the documents.
237
247
  # Defaults to a read-only transaction.
238
248
  # The new transaction ID will be returned as the first response in the
239
249
  # stream.
250
+ #
251
+ # 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.
240
252
  # @!attribute [rw] read_time
241
253
  # @return [::Google::Protobuf::Timestamp]
242
254
  # Reads documents as they were at the given time.
@@ -244,6 +256,8 @@ module Google
244
256
  # This must be a microsecond precision timestamp within the past one hour,
245
257
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
246
258
  # minute timestamp within the past 7 days.
259
+ #
260
+ # 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.
247
261
  class BatchGetDocumentsRequest
248
262
  include ::Google::Protobuf::MessageExts
249
263
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -254,10 +268,14 @@ module Google
254
268
  # @!attribute [rw] found
255
269
  # @return [::Google::Cloud::Firestore::V1::Document]
256
270
  # A document that was requested.
271
+ #
272
+ # 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.
257
273
  # @!attribute [rw] missing
258
274
  # @return [::String]
259
275
  # A document name that was requested but does not exist. In the format:
260
276
  # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
277
+ #
278
+ # 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.
261
279
  # @!attribute [rw] transaction
262
280
  # @return [::String]
263
281
  # The transaction that was started as part of this request.
@@ -364,12 +382,16 @@ module Google
364
382
  # Run the query within an already active transaction.
365
383
  #
366
384
  # The value here is the opaque transaction ID to execute the query in.
385
+ #
386
+ # 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.
367
387
  # @!attribute [rw] new_transaction
368
388
  # @return [::Google::Cloud::Firestore::V1::TransactionOptions]
369
389
  # Starts a new transaction and reads the documents.
370
390
  # Defaults to a read-only transaction.
371
391
  # The new transaction ID will be returned as the first response in the
372
392
  # stream.
393
+ #
394
+ # 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.
373
395
  # @!attribute [rw] read_time
374
396
  # @return [::Google::Protobuf::Timestamp]
375
397
  # Reads documents as they were at the given time.
@@ -377,6 +399,8 @@ module Google
377
399
  # This must be a microsecond precision timestamp within the past one hour,
378
400
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
379
401
  # minute timestamp within the past 7 days.
402
+ #
403
+ # 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.
380
404
  # @!attribute [rw] explain_options
381
405
  # @return [::Google::Cloud::Firestore::V1::ExplainOptions]
382
406
  # Optional. Explain options for the query. If set, additional query
@@ -443,12 +467,16 @@ module Google
443
467
  # Run the aggregation within an already active transaction.
444
468
  #
445
469
  # The value here is the opaque transaction ID to execute the query in.
470
+ #
471
+ # 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.
446
472
  # @!attribute [rw] new_transaction
447
473
  # @return [::Google::Cloud::Firestore::V1::TransactionOptions]
448
474
  # Starts a new transaction as part of the query, defaulting to read-only.
449
475
  #
450
476
  # The new transaction ID will be returned as the first response in the
451
477
  # stream.
478
+ #
479
+ # 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.
452
480
  # @!attribute [rw] read_time
453
481
  # @return [::Google::Protobuf::Timestamp]
454
482
  # Executes the query at the given timestamp.
@@ -456,6 +484,8 @@ module Google
456
484
  # This must be a microsecond precision timestamp within the past one hour,
457
485
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
458
486
  # minute timestamp within the past 7 days.
487
+ #
488
+ # 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.
459
489
  # @!attribute [rw] explain_options
460
490
  # @return [::Google::Cloud::Firestore::V1::ExplainOptions]
461
491
  # Optional. Explain options for the query. If set, additional query
@@ -684,9 +714,13 @@ module Google
684
714
  # @!attribute [rw] add_target
685
715
  # @return [::Google::Cloud::Firestore::V1::Target]
686
716
  # A target to add to this stream.
717
+ #
718
+ # 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.
687
719
  # @!attribute [rw] remove_target
688
720
  # @return [::Integer]
689
721
  # The ID of a target to remove from this stream.
722
+ #
723
+ # 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.
690
724
  # @!attribute [rw] labels
691
725
  # @return [::Google::Protobuf::Map{::String => ::String}]
692
726
  # Labels associated with this target change.
@@ -708,16 +742,24 @@ module Google
708
742
  # @!attribute [rw] target_change
709
743
  # @return [::Google::Cloud::Firestore::V1::TargetChange]
710
744
  # Targets have changed.
745
+ #
746
+ # 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.
711
747
  # @!attribute [rw] document_change
712
748
  # @return [::Google::Cloud::Firestore::V1::DocumentChange]
713
749
  # A {::Google::Cloud::Firestore::V1::Document Document} has changed.
750
+ #
751
+ # 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.
714
752
  # @!attribute [rw] document_delete
715
753
  # @return [::Google::Cloud::Firestore::V1::DocumentDelete]
716
754
  # A {::Google::Cloud::Firestore::V1::Document Document} has been deleted.
755
+ #
756
+ # 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.
717
757
  # @!attribute [rw] document_remove
718
758
  # @return [::Google::Cloud::Firestore::V1::DocumentRemove]
719
759
  # A {::Google::Cloud::Firestore::V1::Document Document} has been removed from a target
720
760
  # (because it is no longer relevant to that target).
761
+ #
762
+ # 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.
721
763
  # @!attribute [rw] filter
722
764
  # @return [::Google::Cloud::Firestore::V1::ExistenceFilter]
723
765
  # A filter to apply to the set of documents previously returned for the
@@ -725,6 +767,8 @@ module Google
725
767
  #
726
768
  # Returned when documents may have been removed from the given target, but
727
769
  # the exact documents are unknown.
770
+ #
771
+ # 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.
728
772
  class ListenResponse
729
773
  include ::Google::Protobuf::MessageExts
730
774
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -734,20 +778,28 @@ module Google
734
778
  # @!attribute [rw] query
735
779
  # @return [::Google::Cloud::Firestore::V1::Target::QueryTarget]
736
780
  # A target specified by a query.
781
+ #
782
+ # 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.
737
783
  # @!attribute [rw] documents
738
784
  # @return [::Google::Cloud::Firestore::V1::Target::DocumentsTarget]
739
785
  # A target specified by a set of document names.
786
+ #
787
+ # 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.
740
788
  # @!attribute [rw] resume_token
741
789
  # @return [::String]
742
790
  # A resume token from a prior
743
791
  # {::Google::Cloud::Firestore::V1::TargetChange TargetChange} for an identical target.
744
792
  #
745
793
  # Using a resume token with a different target is unsupported and may fail.
794
+ #
795
+ # 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.
746
796
  # @!attribute [rw] read_time
747
797
  # @return [::Google::Protobuf::Timestamp]
748
798
  # Start listening after a specific `read_time`.
749
799
  #
750
800
  # The client must know the state of matching documents at this time.
801
+ #
802
+ # 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.
751
803
  # @!attribute [rw] target_id
752
804
  # @return [::Integer]
753
805
  # The target ID that identifies the target on the stream. Must be a positive
@@ -130,7 +130,7 @@ module Google
130
130
  # * The value must be greater than or equal to zero if specified.
131
131
  # @!attribute [rw] find_nearest
132
132
  # @return [::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest]
133
- # Optional. A potential Nearest Neighbors Search.
133
+ # Optional. A potential nearest neighbors search.
134
134
  #
135
135
  # Applies after all other filters and ordering.
136
136
  #
@@ -158,12 +158,18 @@ module Google
158
158
  # @!attribute [rw] composite_filter
159
159
  # @return [::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter]
160
160
  # A composite filter.
161
+ #
162
+ # 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.
161
163
  # @!attribute [rw] field_filter
162
164
  # @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter]
163
165
  # A filter on a document field.
166
+ #
167
+ # 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.
164
168
  # @!attribute [rw] unary_filter
165
169
  # @return [::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter]
166
170
  # A filter that takes exactly one argument.
171
+ #
172
+ # 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.
167
173
  class Filter
168
174
  include ::Google::Protobuf::MessageExts
169
175
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -369,7 +375,10 @@ module Google
369
375
  extend ::Google::Protobuf::MessageExts::ClassMethods
370
376
  end
371
377
 
372
- # Nearest Neighbors search config.
378
+ # Nearest Neighbors search config. The ordering provided by FindNearest
379
+ # supersedes the order_by stage. If multiple documents have the same vector
380
+ # distance, the returned document order is not guaranteed to be stable
381
+ # between queries.
373
382
  # @!attribute [rw] vector_field
374
383
  # @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference]
375
384
  # Required. An indexed vector field to search upon. Only documents which
@@ -381,11 +390,26 @@ module Google
381
390
  # no more than 2048 dimensions.
382
391
  # @!attribute [rw] distance_measure
383
392
  # @return [::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure]
384
- # Required. The Distance Measure to use, required.
393
+ # Required. The distance measure to use, required.
385
394
  # @!attribute [rw] limit
386
395
  # @return [::Google::Protobuf::Int32Value]
387
396
  # Required. The number of nearest neighbors to return. Must be a positive
388
397
  # integer of no more than 1000.
398
+ # @!attribute [rw] distance_result_field
399
+ # @return [::String]
400
+ # Optional. Optional name of the field to output the result of the vector
401
+ # distance calculation. Must conform to [document field
402
+ # name][google.firestore.v1.Document.fields] limitations.
403
+ # @!attribute [rw] distance_threshold
404
+ # @return [::Google::Protobuf::DoubleValue]
405
+ # Optional. Option to specify a threshold for which no less similar
406
+ # documents will be returned. The behavior of the specified
407
+ # `distance_measure` will affect the meaning of the distance threshold.
408
+ # Since DOT_PRODUCT distances increase when the vectors are more similar,
409
+ # the comparison is inverted.
410
+ #
411
+ # For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold
412
+ # For DOT_PRODUCT: WHERE distance >= distance_threshold
389
413
  class FindNearest
390
414
  include ::Google::Protobuf::MessageExts
391
415
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -397,20 +421,23 @@ module Google
397
421
 
398
422
  # Measures the EUCLIDEAN distance between the vectors. See
399
423
  # [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn
400
- # more
424
+ # more. The resulting distance decreases the more similar two vectors
425
+ # are.
401
426
  EUCLIDEAN = 1
402
427
 
403
- # Compares vectors based on the angle between them, which allows you to
404
- # measure similarity that isn't based on the vectors magnitude.
405
- # We recommend using DOT_PRODUCT with unit normalized vectors instead of
406
- # COSINE distance, which is mathematically equivalent with better
407
- # performance. See [Cosine
428
+ # COSINE distance compares vectors based on the angle between them, which
429
+ # allows you to measure similarity that isn't based on the vectors
430
+ # magnitude. We recommend using DOT_PRODUCT with unit normalized vectors
431
+ # instead of COSINE distance, which is mathematically equivalent with
432
+ # better performance. See [Cosine
408
433
  # Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn
409
- # more.
434
+ # more about COSINE similarity and COSINE distance. The resulting
435
+ # COSINE distance decreases the more similar two vectors are.
410
436
  COSINE = 2
411
437
 
412
438
  # Similar to cosine but is affected by the magnitude of the vectors. See
413
439
  # [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more.
440
+ # The resulting distance increases the more similar two vectors are.
414
441
  DOT_PRODUCT = 3
415
442
  end
416
443
  end
@@ -449,12 +476,18 @@ module Google
449
476
  # @!attribute [rw] count
450
477
  # @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count]
451
478
  # Count aggregator.
479
+ #
480
+ # 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.
452
481
  # @!attribute [rw] sum
453
482
  # @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Sum]
454
483
  # Sum aggregator.
484
+ #
485
+ # 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.
455
486
  # @!attribute [rw] avg
456
487
  # @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Avg]
457
488
  # Average aggregator.
489
+ #
490
+ # 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.
458
491
  # @!attribute [rw] alias
459
492
  # @return [::String]
460
493
  # Optional. Optional name of the field to store the result of the
@@ -25,13 +25,19 @@ module Google
25
25
  # @!attribute [rw] update
26
26
  # @return [::Google::Cloud::Firestore::V1::Document]
27
27
  # A document to write.
28
+ #
29
+ # 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.
28
30
  # @!attribute [rw] delete
29
31
  # @return [::String]
30
32
  # A document name to delete. In the format:
31
33
  # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
34
+ #
35
+ # 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.
32
36
  # @!attribute [rw] transform
33
37
  # @return [::Google::Cloud::Firestore::V1::DocumentTransform]
34
38
  # Applies a transformation to a document.
39
+ #
40
+ # 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.
35
41
  # @!attribute [rw] update_mask
36
42
  # @return [::Google::Cloud::Firestore::V1::DocumentMask]
37
43
  # The fields to update in this write.
@@ -83,6 +89,8 @@ module Google
83
89
  # @!attribute [rw] set_to_server_value
84
90
  # @return [::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform::ServerValue]
85
91
  # Sets the field to the given server value.
92
+ #
93
+ # 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.
86
94
  # @!attribute [rw] increment
87
95
  # @return [::Google::Cloud::Firestore::V1::Value]
88
96
  # Adds the given value to the field's current value.
@@ -95,6 +103,8 @@ module Google
95
103
  # representation of double values follow IEEE 754 semantics.
96
104
  # If there is positive/negative integer overflow, the field is resolved
97
105
  # to the largest magnitude positive/negative integer.
106
+ #
107
+ # 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.
98
108
  # @!attribute [rw] maximum
99
109
  # @return [::Google::Cloud::Firestore::V1::Value]
100
110
  # Sets the field to the maximum of its current value and the given value.
@@ -109,6 +119,8 @@ module Google
109
119
  # 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and
110
120
  # zero input value is always the stored value.
111
121
  # The maximum of any numeric value x and NaN is NaN.
122
+ #
123
+ # 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.
112
124
  # @!attribute [rw] minimum
113
125
  # @return [::Google::Cloud::Firestore::V1::Value]
114
126
  # Sets the field to the minimum of its current value and the given value.
@@ -123,6 +135,8 @@ module Google
123
135
  # 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and
124
136
  # zero input value is always the stored value.
125
137
  # The minimum of any numeric value x and NaN is NaN.
138
+ #
139
+ # 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.
126
140
  # @!attribute [rw] append_missing_elements
127
141
  # @return [::Google::Cloud::Firestore::V1::ArrayValue]
128
142
  # Append the given elements in order if they are not already present in
@@ -137,6 +151,8 @@ module Google
137
151
  # be considered.
138
152
  #
139
153
  # The corresponding transform_result will be the null value.
154
+ #
155
+ # 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.
140
156
  # @!attribute [rw] remove_all_from_array
141
157
  # @return [::Google::Cloud::Firestore::V1::ArrayValue]
142
158
  # Remove all of the given elements from the array in the field.
@@ -149,6 +165,8 @@ module Google
149
165
  # This will remove all equivalent values if there are duplicates.
150
166
  #
151
167
  # The corresponding transform_result will be the null value.
168
+ #
169
+ # 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.
152
170
  class FieldTransform
153
171
  include ::Google::Protobuf::MessageExts
154
172
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -53,21 +53,33 @@ module Google
53
53
  # @!attribute [rw] null_value
54
54
  # @return [::Google::Protobuf::NullValue]
55
55
  # Represents a null value.
56
+ #
57
+ # 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.
56
58
  # @!attribute [rw] number_value
57
59
  # @return [::Float]
58
60
  # Represents a double value.
61
+ #
62
+ # 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.
59
63
  # @!attribute [rw] string_value
60
64
  # @return [::String]
61
65
  # Represents a string value.
66
+ #
67
+ # 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.
62
68
  # @!attribute [rw] bool_value
63
69
  # @return [::Boolean]
64
70
  # Represents a boolean value.
71
+ #
72
+ # 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.
65
73
  # @!attribute [rw] struct_value
66
74
  # @return [::Google::Protobuf::Struct]
67
75
  # Represents a structured value.
76
+ #
77
+ # 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.
68
78
  # @!attribute [rw] list_value
69
79
  # @return [::Google::Protobuf::ListValue]
70
80
  # Represents a repeated `Value`.
81
+ #
82
+ # 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.
71
83
  class Value
72
84
  include ::Google::Protobuf::MessageExts
73
85
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-07-09 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.21.1
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.21.1
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -121,7 +120,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
121
120
  licenses:
122
121
  - Apache-2.0
123
122
  metadata: {}
124
- post_install_message:
125
123
  rdoc_options: []
126
124
  require_paths:
127
125
  - lib
@@ -129,15 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
129
127
  requirements:
130
128
  - - ">="
131
129
  - !ruby/object:Gem::Version
132
- version: '2.7'
130
+ version: '3.0'
133
131
  required_rubygems_version: !ruby/object:Gem::Requirement
134
132
  requirements:
135
133
  - - ">="
136
134
  - !ruby/object:Gem::Version
137
135
  version: '0'
138
136
  requirements: []
139
- rubygems_version: 3.5.6
140
- signing_key:
137
+ rubygems_version: 3.6.2
141
138
  specification_version: 4
142
139
  summary: Accesses the NoSQL document database built for automatic scaling, high performance,
143
140
  and ease of application development.