google-cloud-firestore-v1 2.4.0 → 2.6.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.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +0 -4
  3. data/lib/google/cloud/firestore/v1/firestore/client.rb +48 -18
  4. data/lib/google/cloud/firestore/v1/firestore/credentials.rb +1 -1
  5. data/lib/google/cloud/firestore/v1/firestore/rest/client.rb +46 -16
  6. data/lib/google/cloud/firestore/v1/firestore/rest/service_stub.rb +10 -10
  7. data/lib/google/cloud/firestore/v1/firestore/rest.rb +1 -1
  8. data/lib/google/cloud/firestore/v1/firestore.rb +1 -1
  9. data/lib/google/cloud/firestore/v1/rest.rb +1 -1
  10. data/lib/google/cloud/firestore/v1/version.rb +1 -1
  11. data/lib/google/cloud/firestore/v1.rb +1 -1
  12. data/lib/google/firestore/v1/common_pb.rb +2 -1
  13. data/lib/google/firestore/v1/document_pb.rb +1 -1
  14. data/lib/google/firestore/v1/firestore_pb.rb +1 -1
  15. data/lib/google/firestore/v1/firestore_services_pb.rb +1 -1
  16. data/lib/google/firestore/v1/pipeline_pb.rb +1 -1
  17. data/lib/google/firestore/v1/query_pb.rb +1 -1
  18. data/lib/google/firestore/v1/query_profile_pb.rb +1 -1
  19. data/lib/google-cloud-firestore-v1.rb +1 -1
  20. data/proto_docs/google/api/client.rb +1 -1
  21. data/proto_docs/google/api/field_behavior.rb +1 -1
  22. data/proto_docs/google/api/launch_stage.rb +1 -1
  23. data/proto_docs/google/api/resource.rb +1 -1
  24. data/proto_docs/google/api/routing.rb +1 -1
  25. data/proto_docs/google/firestore/v1/aggregation_result.rb +1 -1
  26. data/proto_docs/google/firestore/v1/bloom_filter.rb +1 -1
  27. data/proto_docs/google/firestore/v1/common.rb +10 -1
  28. data/proto_docs/google/firestore/v1/document.rb +1 -1
  29. data/proto_docs/google/firestore/v1/explain_stats.rb +1 -1
  30. data/proto_docs/google/firestore/v1/firestore.rb +52 -1
  31. data/proto_docs/google/firestore/v1/pipeline.rb +1 -1
  32. data/proto_docs/google/firestore/v1/query.rb +1 -1
  33. data/proto_docs/google/firestore/v1/query_profile.rb +1 -1
  34. data/proto_docs/google/firestore/v1/write.rb +1 -1
  35. data/proto_docs/google/protobuf/any.rb +1 -1
  36. data/proto_docs/google/protobuf/duration.rb +1 -1
  37. data/proto_docs/google/protobuf/empty.rb +1 -1
  38. data/proto_docs/google/protobuf/struct.rb +1 -1
  39. data/proto_docs/google/protobuf/timestamp.rb +8 -7
  40. data/proto_docs/google/protobuf/wrappers.rb +1 -1
  41. data/proto_docs/google/rpc/status.rb +1 -1
  42. data/proto_docs/google/type/latlng.rb +1 -1
  43. metadata +5 -5
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -47,6 +47,9 @@ module Google
47
47
  # minute timestamp within the past 7 days.
48
48
  #
49
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.
50
+ # @!attribute [rw] request_options
51
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
52
+ # Optional. Any additional options for the request.
50
53
  class GetDocumentRequest
51
54
  include ::Google::Protobuf::MessageExts
52
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -123,6 +126,9 @@ module Google
123
126
  # {::Google::Cloud::Firestore::V1::Document#update_time `update_time`} set.
124
127
  #
125
128
  # Requests with `show_missing` may not specify `where` or `order_by`.
129
+ # @!attribute [rw] request_options
130
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
131
+ # Optional. Any additional options for the request.
126
132
  class ListDocumentsRequest
127
133
  include ::Google::Protobuf::MessageExts
128
134
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -168,6 +174,9 @@ module Google
168
174
  #
169
175
  # If the document has a field that is not present in this mask, that field
170
176
  # will not be returned in the response.
177
+ # @!attribute [rw] request_options
178
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
179
+ # Optional. Any additional options for the request.
171
180
  class CreateDocumentRequest
172
181
  include ::Google::Protobuf::MessageExts
173
182
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -198,6 +207,9 @@ module Google
198
207
  # @return [::Google::Cloud::Firestore::V1::Precondition]
199
208
  # An optional precondition on the document.
200
209
  # The request will fail if this is set and not met by the target document.
210
+ # @!attribute [rw] request_options
211
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
212
+ # Optional. Any additional options for the request.
201
213
  class UpdateDocumentRequest
202
214
  include ::Google::Protobuf::MessageExts
203
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -213,6 +225,9 @@ module Google
213
225
  # @return [::Google::Cloud::Firestore::V1::Precondition]
214
226
  # An optional precondition on the document.
215
227
  # The request will fail if this is set and not met by the target document.
228
+ # @!attribute [rw] request_options
229
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
230
+ # Optional. Any additional options for the request.
216
231
  class DeleteDocumentRequest
217
232
  include ::Google::Protobuf::MessageExts
218
233
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -258,6 +273,9 @@ module Google
258
273
  # minute timestamp within the past 7 days.
259
274
  #
260
275
  # 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.
276
+ # @!attribute [rw] request_options
277
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
278
+ # Optional. Any additional options for the request.
261
279
  class BatchGetDocumentsRequest
262
280
  include ::Google::Protobuf::MessageExts
263
281
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -303,6 +321,9 @@ module Google
303
321
  # @return [::Google::Cloud::Firestore::V1::TransactionOptions]
304
322
  # The options for the transaction.
305
323
  # Defaults to a read-write transaction.
324
+ # @!attribute [rw] request_options
325
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
326
+ # Optional. Any additional options for the request.
306
327
  class BeginTransactionRequest
307
328
  include ::Google::Protobuf::MessageExts
308
329
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -331,6 +352,9 @@ module Google
331
352
  # @!attribute [rw] transaction
332
353
  # @return [::String]
333
354
  # If set, applies all writes in this transaction, and commits it.
355
+ # @!attribute [rw] request_options
356
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
357
+ # Optional. Any additional options for the request.
334
358
  class CommitRequest
335
359
  include ::Google::Protobuf::MessageExts
336
360
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -360,6 +384,9 @@ module Google
360
384
  # @!attribute [rw] transaction
361
385
  # @return [::String]
362
386
  # Required. The transaction to roll back.
387
+ # @!attribute [rw] request_options
388
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
389
+ # Optional. Any additional options for the request.
363
390
  class RollbackRequest
364
391
  include ::Google::Protobuf::MessageExts
365
392
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -405,6 +432,9 @@ module Google
405
432
  # @return [::Google::Cloud::Firestore::V1::ExplainOptions]
406
433
  # Optional. Explain options for the query. If set, additional query
407
434
  # statistics will be returned. If not, only query results will be returned.
435
+ # @!attribute [rw] request_options
436
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
437
+ # Optional. Any additional options for the request.
408
438
  class RunQueryRequest
409
439
  include ::Google::Protobuf::MessageExts
410
440
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -487,6 +517,9 @@ module Google
487
517
  # Optional. Automatically commits the transaction after the pipeline has been
488
518
  # executed. Only permitted in combination with `transaction` or
489
519
  # `new_transaction`.
520
+ # @!attribute [rw] request_options
521
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
522
+ # Optional. Any additional options for the request.
490
523
  class ExecutePipelineRequest
491
524
  include ::Google::Protobuf::MessageExts
492
525
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -581,6 +614,9 @@ module Google
581
614
  # @return [::Google::Cloud::Firestore::V1::ExplainOptions]
582
615
  # Optional. Explain options for the query. If set, additional query
583
616
  # statistics will be returned. If not, only query results will be returned.
617
+ # @!attribute [rw] request_options
618
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
619
+ # Optional. Any additional options for the request.
584
620
  class RunAggregationQueryRequest
585
621
  include ::Google::Protobuf::MessageExts
586
622
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -674,6 +710,9 @@ module Google
674
710
  # This must be a microsecond precision timestamp within the past one hour,
675
711
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
676
712
  # minute timestamp within the past 7 days.
713
+ # @!attribute [rw] request_options
714
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
715
+ # Optional. Any additional options for the request.
677
716
  class PartitionQueryRequest
678
717
  include ::Google::Protobuf::MessageExts
679
718
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -757,6 +796,9 @@ module Google
757
796
  # @!attribute [rw] labels
758
797
  # @return [::Google::Protobuf::Map{::String => ::String}]
759
798
  # Labels associated with this write request.
799
+ # @!attribute [rw] request_options
800
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
801
+ # Optional. Any additional options for the request.
760
802
  class WriteRequest
761
803
  include ::Google::Protobuf::MessageExts
762
804
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -815,6 +857,9 @@ module Google
815
857
  # @!attribute [rw] labels
816
858
  # @return [::Google::Protobuf::Map{::String => ::String}]
817
859
  # Labels associated with this target change.
860
+ # @!attribute [rw] request_options
861
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
862
+ # Optional. Any additional options for the request.
818
863
  class ListenRequest
819
864
  include ::Google::Protobuf::MessageExts
820
865
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1046,6 +1091,9 @@ module Google
1046
1091
  # This must be a microsecond precision timestamp within the past one hour,
1047
1092
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
1048
1093
  # minute timestamp within the past 7 days.
1094
+ # @!attribute [rw] request_options
1095
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
1096
+ # Optional. Any additional options for the request.
1049
1097
  class ListCollectionIdsRequest
1050
1098
  include ::Google::Protobuf::MessageExts
1051
1099
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1080,6 +1128,9 @@ module Google
1080
1128
  # @!attribute [rw] labels
1081
1129
  # @return [::Google::Protobuf::Map{::String => ::String}]
1082
1130
  # Labels associated with this batch write.
1131
+ # @!attribute [rw] request_options
1132
+ # @return [::Google::Cloud::Firestore::V1::RequestOptions]
1133
+ # Optional. Any additional options for the request.
1083
1134
  class BatchWriteRequest
1084
1135
  include ::Google::Protobuf::MessageExts
1085
1136
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2025 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2024 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2022 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -110,14 +110,15 @@ module Google
110
110
  # ) to obtain a formatter capable of generating timestamps in this format.
111
111
  # @!attribute [rw] seconds
112
112
  # @return [::Integer]
113
- # Represents seconds of UTC time since Unix epoch
114
- # 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
115
- # 9999-12-31T23:59:59Z inclusive.
113
+ # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must
114
+ # be between -315576000000 and 315576000000 inclusive (which corresponds to
115
+ # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
116
116
  # @!attribute [rw] nanos
117
117
  # @return [::Integer]
118
- # Non-negative fractions of a second at nanosecond resolution. Negative
119
- # second values with fractions must still have non-negative nanos values
120
- # that count forward in time. Must be from 0 to 999,999,999
118
+ # Non-negative fractions of a second at nanosecond resolution. This field is
119
+ # the nanosecond portion of the duration, not an alternative to seconds.
120
+ # Negative second values with fractions must still have non-negative nanos
121
+ # values that count forward in time. Must be between 0 and 999,999,999
121
122
  # inclusive.
122
123
  class Timestamp
123
124
  include ::Google::Protobuf::MessageExts
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2020 Google LLC
3
+ # Copyright 2026 Google LLC
4
4
  #
5
5
  # Licensed under the Apache License, Version 2.0 (the "License");
6
6
  # you may not use this file except in compliance with the License.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.4.0
4
+ version: 2.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -15,14 +15,14 @@ dependencies:
15
15
  requirements:
16
16
  - - "~>"
17
17
  - !ruby/object:Gem::Version
18
- version: '1.3'
18
+ version: '1.6'
19
19
  type: :runtime
20
20
  prerelease: false
21
21
  version_requirements: !ruby/object:Gem::Requirement
22
22
  requirements:
23
23
  - - "~>"
24
24
  - !ruby/object:Gem::Version
25
- version: '1.3'
25
+ version: '1.6'
26
26
  - !ruby/object:Gem::Dependency
27
27
  name: google-cloud-errors
28
28
  requirement: !ruby/object:Gem::Requirement
@@ -51,8 +51,8 @@ dependencies:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
53
  version: '1.0'
54
- description: Cloud Firestore is a NoSQL document database built for automatic scaling,
55
- high performance, and ease of application development. Note that google-cloud-firestore-v1
54
+ description: Accesses the NoSQL document database built for automatic scaling, high
55
+ performance, and ease of application development. Note that google-cloud-firestore-v1
56
56
  is a version-specific client library. For most uses, we recommend installing the
57
57
  main client library google-cloud-firestore instead. See the readme for more details.
58
58
  email: googleapis-packages@google.com