google-cloud-firestore-v1 2.3.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 (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -5
  3. data/lib/google/cloud/firestore/v1/firestore/client.rb +62 -23
  4. data/lib/google/cloud/firestore/v1/firestore/credentials.rb +1 -1
  5. data/lib/google/cloud/firestore/v1/firestore/rest/client.rb +60 -21
  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/aggregation_result_pb.rb +2 -24
  13. data/lib/google/firestore/v1/bloom_filter_pb.rb +2 -23
  14. data/lib/google/firestore/v1/common_pb.rb +6 -25
  15. data/lib/google/firestore/v1/document_pb.rb +3 -26
  16. data/lib/google/firestore/v1/explain_stats_pb.rb +2 -24
  17. data/lib/google/firestore/v1/firestore_pb.rb +3 -35
  18. data/lib/google/firestore/v1/firestore_services_pb.rb +1 -1
  19. data/lib/google/firestore/v1/pipeline_pb.rb +3 -25
  20. data/lib/google/firestore/v1/query_pb.rb +3 -26
  21. data/lib/google/firestore/v1/query_profile_pb.rb +3 -26
  22. data/lib/google/firestore/v1/write_pb.rb +2 -27
  23. data/lib/google-cloud-firestore-v1.rb +1 -1
  24. data/proto_docs/google/api/client.rb +150 -30
  25. data/proto_docs/google/api/field_behavior.rb +1 -1
  26. data/proto_docs/google/api/launch_stage.rb +1 -1
  27. data/proto_docs/google/api/resource.rb +1 -1
  28. data/proto_docs/google/api/routing.rb +8 -4
  29. data/proto_docs/google/firestore/v1/aggregation_result.rb +1 -1
  30. data/proto_docs/google/firestore/v1/bloom_filter.rb +1 -1
  31. data/proto_docs/google/firestore/v1/common.rb +32 -4
  32. data/proto_docs/google/firestore/v1/document.rb +24 -15
  33. data/proto_docs/google/firestore/v1/explain_stats.rb +1 -1
  34. data/proto_docs/google/firestore/v1/firestore.rb +60 -1
  35. data/proto_docs/google/firestore/v1/pipeline.rb +1 -1
  36. data/proto_docs/google/firestore/v1/query.rb +14 -4
  37. data/proto_docs/google/firestore/v1/query_profile.rb +1 -1
  38. data/proto_docs/google/firestore/v1/write.rb +1 -1
  39. data/proto_docs/google/protobuf/any.rb +1 -1
  40. data/proto_docs/google/protobuf/duration.rb +1 -1
  41. data/proto_docs/google/protobuf/empty.rb +1 -1
  42. data/proto_docs/google/protobuf/struct.rb +1 -1
  43. data/proto_docs/google/protobuf/timestamp.rb +8 -7
  44. data/proto_docs/google/protobuf/wrappers.rb +28 -1
  45. data/proto_docs/google/rpc/status.rb +1 -1
  46. data/proto_docs/google/type/latlng.rb +4 -4
  47. metadata +6 -6
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2023 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.
@@ -100,7 +100,7 @@ module Google
100
100
 
101
101
  default_config.rpcs.batch_get_documents.timeout = 300.0
102
102
  default_config.rpcs.batch_get_documents.retry_policy = {
103
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
103
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
104
104
  }
105
105
 
106
106
  default_config.rpcs.begin_transaction.timeout = 60.0
@@ -120,22 +120,22 @@ module Google
120
120
 
121
121
  default_config.rpcs.run_query.timeout = 300.0
122
122
  default_config.rpcs.run_query.retry_policy = {
123
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
123
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
124
124
  }
125
125
 
126
126
  default_config.rpcs.execute_pipeline.timeout = 300.0
127
127
  default_config.rpcs.execute_pipeline.retry_policy = {
128
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
128
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13]
129
129
  }
130
130
 
131
131
  default_config.rpcs.run_aggregation_query.timeout = 300.0
132
132
  default_config.rpcs.run_aggregation_query.retry_policy = {
133
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
133
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
134
134
  }
135
135
 
136
136
  default_config.rpcs.partition_query.timeout = 300.0
137
137
  default_config.rpcs.partition_query.retry_policy = {
138
- initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
138
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
139
139
  }
140
140
 
141
141
  default_config.rpcs.list_collection_ids.timeout = 60.0
@@ -285,7 +285,7 @@ module Google
285
285
  # @param options [::Gapic::CallOptions, ::Hash]
286
286
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
287
287
  #
288
- # @overload get_document(name: nil, mask: nil, transaction: nil, read_time: nil)
288
+ # @overload get_document(name: nil, mask: nil, transaction: nil, read_time: nil, request_options: nil)
289
289
  # Pass arguments to `get_document` via keyword arguments. Note that at
290
290
  # least one keyword argument is required. To specify no parameters, or to keep all
291
291
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -310,6 +310,8 @@ module Google
310
310
  # minute timestamp within the past 7 days.
311
311
  #
312
312
  # Note: The following parameters are mutually exclusive: `read_time`, `transaction`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
313
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
314
+ # Optional. Any additional options for the request.
313
315
  # @yield [result, operation] Access the result along with the TransportOperation object
314
316
  # @yieldparam result [::Google::Cloud::Firestore::V1::Document]
315
317
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -381,7 +383,7 @@ module Google
381
383
  # @param options [::Gapic::CallOptions, ::Hash]
382
384
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
383
385
  #
384
- # @overload list_documents(parent: nil, collection_id: nil, page_size: nil, page_token: nil, order_by: nil, mask: nil, transaction: nil, read_time: nil, show_missing: nil)
386
+ # @overload list_documents(parent: nil, collection_id: nil, page_size: nil, page_token: nil, order_by: nil, mask: nil, transaction: nil, read_time: nil, show_missing: nil, request_options: nil)
385
387
  # Pass arguments to `list_documents` via keyword arguments. Note that at
386
388
  # least one keyword argument is required. To specify no parameters, or to keep all
387
389
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -446,6 +448,8 @@ module Google
446
448
  # {::Google::Cloud::Firestore::V1::Document#update_time `update_time`} set.
447
449
  #
448
450
  # Requests with `show_missing` may not specify `where` or `order_by`.
451
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
452
+ # Optional. Any additional options for the request.
449
453
  # @yield [result, operation] Access the result along with the TransportOperation object
450
454
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::V1::Document>]
451
455
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -523,7 +527,7 @@ module Google
523
527
  # @param options [::Gapic::CallOptions, ::Hash]
524
528
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
525
529
  #
526
- # @overload update_document(document: nil, update_mask: nil, mask: nil, current_document: nil)
530
+ # @overload update_document(document: nil, update_mask: nil, mask: nil, current_document: nil, request_options: nil)
527
531
  # Pass arguments to `update_document` via keyword arguments. Note that at
528
532
  # least one keyword argument is required. To specify no parameters, or to keep all
529
533
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -547,6 +551,8 @@ module Google
547
551
  # @param current_document [::Google::Cloud::Firestore::V1::Precondition, ::Hash]
548
552
  # An optional precondition on the document.
549
553
  # The request will fail if this is set and not met by the target document.
554
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
555
+ # Optional. Any additional options for the request.
550
556
  # @yield [result, operation] Access the result along with the TransportOperation object
551
557
  # @yieldparam result [::Google::Cloud::Firestore::V1::Document]
552
558
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -618,7 +624,7 @@ module Google
618
624
  # @param options [::Gapic::CallOptions, ::Hash]
619
625
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
620
626
  #
621
- # @overload delete_document(name: nil, current_document: nil)
627
+ # @overload delete_document(name: nil, current_document: nil, request_options: nil)
622
628
  # Pass arguments to `delete_document` via keyword arguments. Note that at
623
629
  # least one keyword argument is required. To specify no parameters, or to keep all
624
630
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -629,6 +635,8 @@ module Google
629
635
  # @param current_document [::Google::Cloud::Firestore::V1::Precondition, ::Hash]
630
636
  # An optional precondition on the document.
631
637
  # The request will fail if this is set and not met by the target document.
638
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
639
+ # Optional. Any additional options for the request.
632
640
  # @yield [result, operation] Access the result along with the TransportOperation object
633
641
  # @yieldparam result [::Google::Protobuf::Empty]
634
642
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -703,7 +711,7 @@ module Google
703
711
  # @param options [::Gapic::CallOptions, ::Hash]
704
712
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
705
713
  #
706
- # @overload batch_get_documents(database: nil, documents: nil, mask: nil, transaction: nil, new_transaction: nil, read_time: nil)
714
+ # @overload batch_get_documents(database: nil, documents: nil, mask: nil, transaction: nil, new_transaction: nil, read_time: nil, request_options: nil)
707
715
  # Pass arguments to `batch_get_documents` via keyword arguments. Note that at
708
716
  # least one keyword argument is required. To specify no parameters, or to keep all
709
717
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -740,6 +748,8 @@ module Google
740
748
  # minute timestamp within the past 7 days.
741
749
  #
742
750
  # Note: The following parameters are mutually exclusive: `read_time`, `transaction`, `new_transaction`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
751
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
752
+ # Optional. Any additional options for the request.
743
753
  # @return [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
744
754
  #
745
755
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
@@ -816,7 +826,7 @@ module Google
816
826
  # @param options [::Gapic::CallOptions, ::Hash]
817
827
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
818
828
  #
819
- # @overload begin_transaction(database: nil, options: nil)
829
+ # @overload begin_transaction(database: nil, options: nil, request_options: nil)
820
830
  # Pass arguments to `begin_transaction` via keyword arguments. Note that at
821
831
  # least one keyword argument is required. To specify no parameters, or to keep all
822
832
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -827,6 +837,8 @@ module Google
827
837
  # @param options [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
828
838
  # The options for the transaction.
829
839
  # Defaults to a read-write transaction.
840
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
841
+ # Optional. Any additional options for the request.
830
842
  # @yield [result, operation] Access the result along with the TransportOperation object
831
843
  # @yieldparam result [::Google::Cloud::Firestore::V1::BeginTransactionResponse]
832
844
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -898,7 +910,7 @@ module Google
898
910
  # @param options [::Gapic::CallOptions, ::Hash]
899
911
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
900
912
  #
901
- # @overload commit(database: nil, writes: nil, transaction: nil)
913
+ # @overload commit(database: nil, writes: nil, transaction: nil, request_options: nil)
902
914
  # Pass arguments to `commit` via keyword arguments. Note that at
903
915
  # least one keyword argument is required. To specify no parameters, or to keep all
904
916
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -912,6 +924,8 @@ module Google
912
924
  # Always executed atomically and in order.
913
925
  # @param transaction [::String]
914
926
  # If set, applies all writes in this transaction, and commits it.
927
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
928
+ # Optional. Any additional options for the request.
915
929
  # @yield [result, operation] Access the result along with the TransportOperation object
916
930
  # @yieldparam result [::Google::Cloud::Firestore::V1::CommitResponse]
917
931
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -983,7 +997,7 @@ module Google
983
997
  # @param options [::Gapic::CallOptions, ::Hash]
984
998
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
985
999
  #
986
- # @overload rollback(database: nil, transaction: nil)
1000
+ # @overload rollback(database: nil, transaction: nil, request_options: nil)
987
1001
  # Pass arguments to `rollback` via keyword arguments. Note that at
988
1002
  # least one keyword argument is required. To specify no parameters, or to keep all
989
1003
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -993,6 +1007,8 @@ module Google
993
1007
  # `projects/{project_id}/databases/{database_id}`.
994
1008
  # @param transaction [::String]
995
1009
  # Required. The transaction to roll back.
1010
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1011
+ # Optional. Any additional options for the request.
996
1012
  # @yield [result, operation] Access the result along with the TransportOperation object
997
1013
  # @yieldparam result [::Google::Protobuf::Empty]
998
1014
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1064,7 +1080,7 @@ module Google
1064
1080
  # @param options [::Gapic::CallOptions, ::Hash]
1065
1081
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1066
1082
  #
1067
- # @overload run_query(parent: nil, structured_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil)
1083
+ # @overload run_query(parent: nil, structured_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil, request_options: nil)
1068
1084
  # Pass arguments to `run_query` via keyword arguments. Note that at
1069
1085
  # least one keyword argument is required. To specify no parameters, or to keep all
1070
1086
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1102,6 +1118,8 @@ module Google
1102
1118
  # @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
1103
1119
  # Optional. Explain options for the query. If set, additional query
1104
1120
  # statistics will be returned. If not, only query results will be returned.
1121
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1122
+ # Optional. Any additional options for the request.
1105
1123
  # @return [::Enumerable<::Google::Cloud::Firestore::V1::RunQueryResponse>]
1106
1124
  #
1107
1125
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
@@ -1178,7 +1196,7 @@ module Google
1178
1196
  # @param options [::Gapic::CallOptions, ::Hash]
1179
1197
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1180
1198
  #
1181
- # @overload execute_pipeline(database: nil, structured_pipeline: nil, transaction: nil, new_transaction: nil, read_time: nil)
1199
+ # @overload execute_pipeline(database: nil, structured_pipeline: nil, transaction: nil, new_transaction: nil, read_time: nil, auto_commit_transaction: nil, request_options: nil)
1182
1200
  # Pass arguments to `execute_pipeline` via keyword arguments. Note that at
1183
1201
  # least one keyword argument is required. To specify no parameters, or to keep all
1184
1202
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1209,6 +1227,12 @@ module Google
1209
1227
  # minute timestamp within the past 7 days.
1210
1228
  #
1211
1229
  # Note: The following parameters are mutually exclusive: `read_time`, `transaction`, `new_transaction`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
1230
+ # @param auto_commit_transaction [::Boolean]
1231
+ # Optional. Automatically commits the transaction after the pipeline has been
1232
+ # executed. Only permitted in combination with `transaction` or
1233
+ # `new_transaction`.
1234
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1235
+ # Optional. Any additional options for the request.
1212
1236
  # @return [::Enumerable<::Google::Cloud::Firestore::V1::ExecutePipelineResponse>]
1213
1237
  #
1214
1238
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
@@ -1297,7 +1321,7 @@ module Google
1297
1321
  # @param options [::Gapic::CallOptions, ::Hash]
1298
1322
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1299
1323
  #
1300
- # @overload run_aggregation_query(parent: nil, structured_aggregation_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil)
1324
+ # @overload run_aggregation_query(parent: nil, structured_aggregation_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil, request_options: nil)
1301
1325
  # Pass arguments to `run_aggregation_query` via keyword arguments. Note that at
1302
1326
  # least one keyword argument is required. To specify no parameters, or to keep all
1303
1327
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1335,6 +1359,8 @@ module Google
1335
1359
  # @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
1336
1360
  # Optional. Explain options for the query. If set, additional query
1337
1361
  # statistics will be returned. If not, only query results will be returned.
1362
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1363
+ # Optional. Any additional options for the request.
1338
1364
  # @return [::Enumerable<::Google::Cloud::Firestore::V1::RunAggregationQueryResponse>]
1339
1365
  #
1340
1366
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
@@ -1413,7 +1439,7 @@ module Google
1413
1439
  # @param options [::Gapic::CallOptions, ::Hash]
1414
1440
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1415
1441
  #
1416
- # @overload partition_query(parent: nil, structured_query: nil, partition_count: nil, page_token: nil, page_size: nil, read_time: nil)
1442
+ # @overload partition_query(parent: nil, structured_query: nil, partition_count: nil, page_token: nil, page_size: nil, read_time: nil, request_options: nil)
1417
1443
  # Pass arguments to `partition_query` via keyword arguments. Note that at
1418
1444
  # least one keyword argument is required. To specify no parameters, or to keep all
1419
1445
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1465,6 +1491,8 @@ module Google
1465
1491
  # This must be a microsecond precision timestamp within the past one hour,
1466
1492
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
1467
1493
  # minute timestamp within the past 7 days.
1494
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1495
+ # Optional. Any additional options for the request.
1468
1496
  # @yield [result, operation] Access the result along with the TransportOperation object
1469
1497
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::V1::Cursor>]
1470
1498
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1542,7 +1570,7 @@ module Google
1542
1570
  # @param options [::Gapic::CallOptions, ::Hash]
1543
1571
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1544
1572
  #
1545
- # @overload list_collection_ids(parent: nil, page_size: nil, page_token: nil, read_time: nil)
1573
+ # @overload list_collection_ids(parent: nil, page_size: nil, page_token: nil, read_time: nil, request_options: nil)
1546
1574
  # Pass arguments to `list_collection_ids` via keyword arguments. Note that at
1547
1575
  # least one keyword argument is required. To specify no parameters, or to keep all
1548
1576
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1552,6 +1580,9 @@ module Google
1552
1580
  # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
1553
1581
  # For example:
1554
1582
  # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
1583
+ #
1584
+ # Use `projects/{project_id}/databases/{database_id}/documents` to list
1585
+ # top-level collections.
1555
1586
  # @param page_size [::Integer]
1556
1587
  # The maximum number of results to return.
1557
1588
  # @param page_token [::String]
@@ -1563,6 +1594,8 @@ module Google
1563
1594
  # This must be a microsecond precision timestamp within the past one hour,
1564
1595
  # or if Point-in-Time Recovery is enabled, can additionally be a whole
1565
1596
  # minute timestamp within the past 7 days.
1597
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1598
+ # Optional. Any additional options for the request.
1566
1599
  # @yield [result, operation] Access the result along with the TransportOperation object
1567
1600
  # @yieldparam result [::Google::Cloud::Firestore::V1::ListCollectionIdsResponse]
1568
1601
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1643,7 +1676,7 @@ module Google
1643
1676
  # @param options [::Gapic::CallOptions, ::Hash]
1644
1677
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1645
1678
  #
1646
- # @overload batch_write(database: nil, writes: nil, labels: nil)
1679
+ # @overload batch_write(database: nil, writes: nil, labels: nil, request_options: nil)
1647
1680
  # Pass arguments to `batch_write` via keyword arguments. Note that at
1648
1681
  # least one keyword argument is required. To specify no parameters, or to keep all
1649
1682
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1659,6 +1692,8 @@ module Google
1659
1692
  # document more than once per request.
1660
1693
  # @param labels [::Hash{::String => ::String}]
1661
1694
  # Labels associated with this batch write.
1695
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1696
+ # Optional. Any additional options for the request.
1662
1697
  # @yield [result, operation] Access the result along with the TransportOperation object
1663
1698
  # @yieldparam result [::Google::Cloud::Firestore::V1::BatchWriteResponse]
1664
1699
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1730,7 +1765,7 @@ module Google
1730
1765
  # @param options [::Gapic::CallOptions, ::Hash]
1731
1766
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1732
1767
  #
1733
- # @overload create_document(parent: nil, collection_id: nil, document_id: nil, document: nil, mask: nil)
1768
+ # @overload create_document(parent: nil, collection_id: nil, document_id: nil, document: nil, mask: nil, request_options: nil)
1734
1769
  # Pass arguments to `create_document` via keyword arguments. Note that at
1735
1770
  # least one keyword argument is required. To specify no parameters, or to keep all
1736
1771
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -1753,6 +1788,8 @@ module Google
1753
1788
  #
1754
1789
  # If the document has a field that is not present in this mask, that field
1755
1790
  # will not be returned in the response.
1791
+ # @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
1792
+ # Optional. Any additional options for the request.
1756
1793
  # @yield [result, operation] Access the result along with the TransportOperation object
1757
1794
  # @yieldparam result [::Google::Cloud::Firestore::V1::Document]
1758
1795
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1881,6 +1918,7 @@ module Google
1881
1918
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1882
1919
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1883
1920
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1921
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
1884
1922
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1885
1923
  # trigger a retry.
1886
1924
  # @return [::Hash]
@@ -1953,6 +1991,7 @@ module Google
1953
1991
  # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
1954
1992
  # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
1955
1993
  # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
1994
+ # * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
1956
1995
  # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
1957
1996
  # trigger a retry.
1958
1997
  #
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2023 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.
@@ -664,7 +664,7 @@ module Google
664
664
  uri_method: :get,
665
665
  uri_template: "/v1/{name}",
666
666
  matches: [
667
- ["name", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true]
667
+ ["name", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true]
668
668
  ]
669
669
  )
670
670
  transcoder.transcode request_pb
@@ -685,7 +685,7 @@ module Google
685
685
  uri_method: :get,
686
686
  uri_template: "/v1/{parent}/{collection_id}",
687
687
  matches: [
688
- ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true],
688
+ ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true],
689
689
  ["collection_id", %r{^[^/]+/?$}, false]
690
690
  ]
691
691
  )
@@ -716,7 +716,7 @@ module Google
716
716
  uri_template: "/v1/{document.name}",
717
717
  body: "document",
718
718
  matches: [
719
- ["document.name", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true]
719
+ ["document.name", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true]
720
720
  ]
721
721
  )
722
722
  transcoder.transcode request_pb
@@ -737,7 +737,7 @@ module Google
737
737
  uri_method: :delete,
738
738
  uri_template: "/v1/{name}",
739
739
  matches: [
740
- ["name", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true]
740
+ ["name", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true]
741
741
  ]
742
742
  )
743
743
  transcoder.transcode request_pb
@@ -855,7 +855,7 @@ module Google
855
855
  uri_template: "/v1/{parent}:runQuery",
856
856
  body: "*",
857
857
  matches: [
858
- ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true]
858
+ ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true]
859
859
  ]
860
860
  )
861
861
  transcoder.transcode request_pb
@@ -907,7 +907,7 @@ module Google
907
907
  uri_template: "/v1/{parent}:runAggregationQuery",
908
908
  body: "*",
909
909
  matches: [
910
- ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true]
910
+ ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true]
911
911
  ]
912
912
  )
913
913
  transcoder.transcode request_pb
@@ -937,7 +937,7 @@ module Google
937
937
  uri_template: "/v1/{parent}:partitionQuery",
938
938
  body: "*",
939
939
  matches: [
940
- ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true]
940
+ ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true]
941
941
  ]
942
942
  )
943
943
  transcoder.transcode request_pb
@@ -967,7 +967,7 @@ module Google
967
967
  uri_template: "/v1/{parent}:listCollectionIds",
968
968
  body: "*",
969
969
  matches: [
970
- ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/.*)?$}, true]
970
+ ["parent", %r{^projects/[^/]+/databases/[^/]+/documents/[^/]+(?:/(?<__wildcard__>.*))?$}, true]
971
971
  ]
972
972
  )
973
973
  transcoder.transcode request_pb
@@ -1011,7 +1011,7 @@ module Google
1011
1011
  uri_template: "/v1/{parent}/{collection_id}",
1012
1012
  body: "document",
1013
1013
  matches: [
1014
- ["parent", %r{^projects/[^/]+/databases/[^/]+/documents(?:/.*)?$}, true],
1014
+ ["parent", %r{^projects/[^/]+/databases/[^/]+/documents(?:/(?<__wildcard__>.*))?$}, true],
1015
1015
  ["collection_id", %r{^[^/]+/?$}, false]
1016
1016
  ]
1017
1017
  )
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Copyright 2023 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 2023 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.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Firestore
23
23
  module V1
24
- VERSION = "2.3.0"
24
+ VERSION = "2.6.0"
25
25
  end
26
26
  end
27
27
  end
@@ -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.
@@ -9,30 +9,8 @@ require 'google/firestore/v1/document_pb'
9
9
 
10
10
  descriptor_data = "\n,google/firestore/v1/aggregation_result.proto\x12\x13google.firestore.v1\x1a\"google/firestore/v1/document.proto\"\xbe\x01\n\x11\x41ggregationResult\x12U\n\x10\x61ggregate_fields\x18\x02 \x03(\x0b\x32;.google.firestore.v1.AggregationResult.AggregateFieldsEntry\x1aR\n\x14\x41ggregateFieldsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.Value:\x02\x38\x01\x42\xce\x01\n\x17\x63om.google.firestore.v1B\x16\x41ggregationResultProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
11
11
 
12
- pool = Google::Protobuf::DescriptorPool.generated_pool
13
-
14
- begin
15
- pool.add_serialized_file(descriptor_data)
16
- rescue TypeError
17
- # Compatibility code: will be removed in the next major version.
18
- require 'google/protobuf/descriptor_pb'
19
- parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
20
- parsed.clear_dependency
21
- serialized = parsed.class.encode(parsed)
22
- file = pool.add_serialized_file(serialized)
23
- warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
24
- imports = [
25
- ["google.firestore.v1.Value", "google/firestore/v1/document.proto"],
26
- ]
27
- imports.each do |type_name, expected_filename|
28
- import_file = pool.lookup(type_name).file_descriptor
29
- if import_file.name != expected_filename
30
- warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
31
- end
32
- end
33
- warn "Each proto file must use a consistent fully-qualified name."
34
- warn "This will become an error in the next major version."
35
- end
12
+ pool = ::Google::Protobuf::DescriptorPool.generated_pool
13
+ pool.add_serialized_file(descriptor_data)
36
14
 
37
15
  module Google
38
16
  module Cloud
@@ -7,29 +7,8 @@ require 'google/protobuf'
7
7
 
8
8
  descriptor_data = "\n&google/firestore/v1/bloom_filter.proto\x12\x13google.firestore.v1\".\n\x0b\x42itSequence\x12\x0e\n\x06\x62itmap\x18\x01 \x01(\x0c\x12\x0f\n\x07padding\x18\x02 \x01(\x05\"Q\n\x0b\x42loomFilter\x12.\n\x04\x62its\x18\x01 \x01(\x0b\x32 .google.firestore.v1.BitSequence\x12\x12\n\nhash_count\x18\x02 \x01(\x05\x42\xc8\x01\n\x17\x63om.google.firestore.v1B\x10\x42loomFilterProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
9
9
 
10
- pool = Google::Protobuf::DescriptorPool.generated_pool
11
-
12
- begin
13
- pool.add_serialized_file(descriptor_data)
14
- rescue TypeError
15
- # Compatibility code: will be removed in the next major version.
16
- require 'google/protobuf/descriptor_pb'
17
- parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
18
- parsed.clear_dependency
19
- serialized = parsed.class.encode(parsed)
20
- file = pool.add_serialized_file(serialized)
21
- warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
22
- imports = [
23
- ]
24
- imports.each do |type_name, expected_filename|
25
- import_file = pool.lookup(type_name).file_descriptor
26
- if import_file.name != expected_filename
27
- warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
28
- end
29
- end
30
- warn "Each proto file must use a consistent fully-qualified name."
31
- warn "This will become an error in the next major version."
32
- end
10
+ pool = ::Google::Protobuf::DescriptorPool.generated_pool
11
+ pool.add_serialized_file(descriptor_data)
33
12
 
34
13
  module Google
35
14
  module Cloud
@@ -4,35 +4,14 @@
4
4
 
5
5
  require 'google/protobuf'
6
6
 
7
+ require 'google/api/field_behavior_pb'
7
8
  require 'google/protobuf/timestamp_pb'
8
9
 
9
10
 
10
- descriptor_data = "\n google/firestore/v1/common.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/protobuf/timestamp.proto\"#\n\x0c\x44ocumentMask\x12\x13\n\x0b\x66ield_paths\x18\x01 \x03(\t\"e\n\x0cPrecondition\x12\x10\n\x06\x65xists\x18\x01 \x01(\x08H\x00\x12\x31\n\x0bupdate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x10\n\x0e\x63ondition_type\"\xa9\x02\n\x12TransactionOptions\x12\x45\n\tread_only\x18\x02 \x01(\x0b\x32\x30.google.firestore.v1.TransactionOptions.ReadOnlyH\x00\x12G\n\nread_write\x18\x03 \x01(\x0b\x32\x31.google.firestore.v1.TransactionOptions.ReadWriteH\x00\x1a&\n\tReadWrite\x12\x19\n\x11retry_transaction\x18\x01 \x01(\x0c\x1aS\n\x08ReadOnly\x12/\n\tread_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x16\n\x14\x63onsistency_selectorB\x06\n\x04modeB\xc3\x01\n\x17\x63om.google.firestore.v1B\x0b\x43ommonProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
11
+ descriptor_data = "\n google/firestore/v1/common.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"#\n\x0c\x44ocumentMask\x12\x13\n\x0b\x66ield_paths\x18\x01 \x03(\t\"e\n\x0cPrecondition\x12\x10\n\x06\x65xists\x18\x01 \x01(\x08H\x00\x12\x31\n\x0bupdate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x10\n\x0e\x63ondition_type\"\xd8\x03\n\x12TransactionOptions\x12\x45\n\tread_only\x18\x02 \x01(\x0b\x32\x30.google.firestore.v1.TransactionOptions.ReadOnlyH\x00\x12G\n\nread_write\x18\x03 \x01(\x0b\x32\x31.google.firestore.v1.TransactionOptions.ReadWriteH\x00\x1a\x7f\n\tReadWrite\x12\x19\n\x11retry_transaction\x18\x01 \x01(\x0c\x12W\n\x10\x63oncurrency_mode\x18\x02 \x01(\x0e\x32\x37.google.firestore.v1.TransactionOptions.ConcurrencyModeB\x04\xe2\x41\x01\x01\x1aS\n\x08ReadOnly\x12/\n\tread_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x16\n\x14\x63onsistency_selector\"T\n\x0f\x43oncurrencyMode\x12 \n\x1c\x43ONCURRENCY_MODE_UNSPECIFIED\x10\x00\x12\x0e\n\nOPTIMISTIC\x10\x01\x12\x0f\n\x0bPESSIMISTIC\x10\x02\x42\x06\n\x04mode\",\n\x0eRequestOptions\x12\x1a\n\x0crequest_tags\x18\x01 \x03(\tB\x04\xe2\x41\x01\x01\x42\xc3\x01\n\x17\x63om.google.firestore.v1B\x0b\x43ommonProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
11
12
 
12
- pool = Google::Protobuf::DescriptorPool.generated_pool
13
-
14
- begin
15
- pool.add_serialized_file(descriptor_data)
16
- rescue TypeError
17
- # Compatibility code: will be removed in the next major version.
18
- require 'google/protobuf/descriptor_pb'
19
- parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
20
- parsed.clear_dependency
21
- serialized = parsed.class.encode(parsed)
22
- file = pool.add_serialized_file(serialized)
23
- warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
24
- imports = [
25
- ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
26
- ]
27
- imports.each do |type_name, expected_filename|
28
- import_file = pool.lookup(type_name).file_descriptor
29
- if import_file.name != expected_filename
30
- warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
31
- end
32
- end
33
- warn "Each proto file must use a consistent fully-qualified name."
34
- warn "This will become an error in the next major version."
35
- end
13
+ pool = ::Google::Protobuf::DescriptorPool.generated_pool
14
+ pool.add_serialized_file(descriptor_data)
36
15
 
37
16
  module Google
38
17
  module Cloud
@@ -43,6 +22,8 @@ module Google
43
22
  TransactionOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions").msgclass
44
23
  TransactionOptions::ReadWrite = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions.ReadWrite").msgclass
45
24
  TransactionOptions::ReadOnly = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions.ReadOnly").msgclass
25
+ TransactionOptions::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions.ConcurrencyMode").enummodule
26
+ RequestOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.RequestOptions").msgclass
46
27
  end
47
28
  end
48
29
  end