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.
- checksums.yaml +4 -4
- data/README.md +1 -5
- data/lib/google/cloud/firestore/v1/firestore/client.rb +62 -23
- data/lib/google/cloud/firestore/v1/firestore/credentials.rb +1 -1
- data/lib/google/cloud/firestore/v1/firestore/rest/client.rb +60 -21
- data/lib/google/cloud/firestore/v1/firestore/rest/service_stub.rb +10 -10
- data/lib/google/cloud/firestore/v1/firestore/rest.rb +1 -1
- data/lib/google/cloud/firestore/v1/firestore.rb +1 -1
- data/lib/google/cloud/firestore/v1/rest.rb +1 -1
- data/lib/google/cloud/firestore/v1/version.rb +1 -1
- data/lib/google/cloud/firestore/v1.rb +1 -1
- data/lib/google/firestore/v1/aggregation_result_pb.rb +2 -24
- data/lib/google/firestore/v1/bloom_filter_pb.rb +2 -23
- data/lib/google/firestore/v1/common_pb.rb +6 -25
- data/lib/google/firestore/v1/document_pb.rb +3 -26
- data/lib/google/firestore/v1/explain_stats_pb.rb +2 -24
- data/lib/google/firestore/v1/firestore_pb.rb +3 -35
- data/lib/google/firestore/v1/firestore_services_pb.rb +1 -1
- data/lib/google/firestore/v1/pipeline_pb.rb +3 -25
- data/lib/google/firestore/v1/query_pb.rb +3 -26
- data/lib/google/firestore/v1/query_profile_pb.rb +3 -26
- data/lib/google/firestore/v1/write_pb.rb +2 -27
- data/lib/google-cloud-firestore-v1.rb +1 -1
- data/proto_docs/google/api/client.rb +150 -30
- data/proto_docs/google/api/field_behavior.rb +1 -1
- data/proto_docs/google/api/launch_stage.rb +1 -1
- data/proto_docs/google/api/resource.rb +1 -1
- data/proto_docs/google/api/routing.rb +8 -4
- data/proto_docs/google/firestore/v1/aggregation_result.rb +1 -1
- data/proto_docs/google/firestore/v1/bloom_filter.rb +1 -1
- data/proto_docs/google/firestore/v1/common.rb +32 -4
- data/proto_docs/google/firestore/v1/document.rb +24 -15
- data/proto_docs/google/firestore/v1/explain_stats.rb +1 -1
- data/proto_docs/google/firestore/v1/firestore.rb +60 -1
- data/proto_docs/google/firestore/v1/pipeline.rb +1 -1
- data/proto_docs/google/firestore/v1/query.rb +14 -4
- data/proto_docs/google/firestore/v1/query_profile.rb +1 -1
- data/proto_docs/google/firestore/v1/write.rb +1 -1
- data/proto_docs/google/protobuf/any.rb +1 -1
- data/proto_docs/google/protobuf/duration.rb +1 -1
- data/proto_docs/google/protobuf/empty.rb +1 -1
- data/proto_docs/google/protobuf/struct.rb +1 -1
- data/proto_docs/google/protobuf/timestamp.rb +8 -7
- data/proto_docs/google/protobuf/wrappers.rb +28 -1
- data/proto_docs/google/rpc/status.rb +1 -1
- data/proto_docs/google/type/latlng.rb +4 -4
- metadata +6 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3f5a1c9bbfe43b427215837c2cd197a6ed2dc226d7c616f9e5a42bb3da59fc83
|
|
4
|
+
data.tar.gz: 6bd0a8067cd9e78a852f0ddd12945a0ae7283927ba3d5e6443980454cdaaaec3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b293605411df9c7940d99b613c49b355e5e298b05beefdcfb2908f0f05428dff99a216bb23e0768bba6d8bea328671656159524edac787a6afa101a6cba05fa5
|
|
7
|
+
data.tar.gz: 3464ff570e026581c56966ae87497ca748b84edf0fbafca6f48779022d7562485c45a82cdfbe1aef896dcc3b310fb08821279e0b625406a88bd8108e22913cf2
|
data/README.md
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
|
|
4
4
|
|
|
5
|
-
Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.
|
|
6
5
|
|
|
7
6
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
7
|
|
|
@@ -40,9 +39,6 @@ response = client.get_document request
|
|
|
40
39
|
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-firestore-v1/latest)
|
|
41
40
|
for class and method documentation.
|
|
42
41
|
|
|
43
|
-
See also the [Product Documentation](https://cloud.google.com/firestore)
|
|
44
|
-
for general usage information.
|
|
45
|
-
|
|
46
42
|
## Debug Logging
|
|
47
43
|
|
|
48
44
|
This library comes with opt-in Debug Logging that can help you troubleshoot
|
|
@@ -86,7 +82,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
|
|
|
86
82
|
|
|
87
83
|
## Supported Ruby Versions
|
|
88
84
|
|
|
89
|
-
This library is supported on Ruby 3.
|
|
85
|
+
This library is supported on Ruby 3.2+.
|
|
90
86
|
|
|
91
87
|
Google provides official support for Ruby versions that are actively supported
|
|
92
88
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
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.
|
|
@@ -98,7 +98,7 @@ module Google
|
|
|
98
98
|
|
|
99
99
|
default_config.rpcs.batch_get_documents.timeout = 300.0
|
|
100
100
|
default_config.rpcs.batch_get_documents.retry_policy = {
|
|
101
|
-
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [
|
|
101
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
|
|
102
102
|
}
|
|
103
103
|
|
|
104
104
|
default_config.rpcs.begin_transaction.timeout = 60.0
|
|
@@ -118,22 +118,22 @@ module Google
|
|
|
118
118
|
|
|
119
119
|
default_config.rpcs.run_query.timeout = 300.0
|
|
120
120
|
default_config.rpcs.run_query.retry_policy = {
|
|
121
|
-
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [
|
|
121
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
|
|
122
122
|
}
|
|
123
123
|
|
|
124
124
|
default_config.rpcs.execute_pipeline.timeout = 300.0
|
|
125
125
|
default_config.rpcs.execute_pipeline.retry_policy = {
|
|
126
|
-
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [
|
|
126
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13]
|
|
127
127
|
}
|
|
128
128
|
|
|
129
129
|
default_config.rpcs.run_aggregation_query.timeout = 300.0
|
|
130
130
|
default_config.rpcs.run_aggregation_query.retry_policy = {
|
|
131
|
-
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [
|
|
131
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
|
|
132
132
|
}
|
|
133
133
|
|
|
134
134
|
default_config.rpcs.partition_query.timeout = 300.0
|
|
135
135
|
default_config.rpcs.partition_query.retry_policy = {
|
|
136
|
-
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [
|
|
136
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
|
|
137
137
|
}
|
|
138
138
|
|
|
139
139
|
default_config.rpcs.write.timeout = 86_400.0
|
|
@@ -299,7 +299,7 @@ module Google
|
|
|
299
299
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
300
300
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
301
301
|
#
|
|
302
|
-
# @overload get_document(name: nil, mask: nil, transaction: nil, read_time: nil)
|
|
302
|
+
# @overload get_document(name: nil, mask: nil, transaction: nil, read_time: nil, request_options: nil)
|
|
303
303
|
# Pass arguments to `get_document` via keyword arguments. Note that at
|
|
304
304
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
305
305
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -324,6 +324,8 @@ module Google
|
|
|
324
324
|
# minute timestamp within the past 7 days.
|
|
325
325
|
#
|
|
326
326
|
# 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.
|
|
327
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
328
|
+
# Optional. Any additional options for the request.
|
|
327
329
|
#
|
|
328
330
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
329
331
|
# @yieldparam response [::Google::Cloud::Firestore::V1::Document]
|
|
@@ -402,7 +404,7 @@ module Google
|
|
|
402
404
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
403
405
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
404
406
|
#
|
|
405
|
-
# @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)
|
|
407
|
+
# @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)
|
|
406
408
|
# Pass arguments to `list_documents` via keyword arguments. Note that at
|
|
407
409
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
408
410
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -467,6 +469,8 @@ module Google
|
|
|
467
469
|
# {::Google::Cloud::Firestore::V1::Document#update_time `update_time`} set.
|
|
468
470
|
#
|
|
469
471
|
# Requests with `show_missing` may not specify `where` or `order_by`.
|
|
472
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
473
|
+
# Optional. Any additional options for the request.
|
|
470
474
|
#
|
|
471
475
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
472
476
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Firestore::V1::Document>]
|
|
@@ -554,7 +558,7 @@ module Google
|
|
|
554
558
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
555
559
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
556
560
|
#
|
|
557
|
-
# @overload update_document(document: nil, update_mask: nil, mask: nil, current_document: nil)
|
|
561
|
+
# @overload update_document(document: nil, update_mask: nil, mask: nil, current_document: nil, request_options: nil)
|
|
558
562
|
# Pass arguments to `update_document` via keyword arguments. Note that at
|
|
559
563
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
560
564
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -578,6 +582,8 @@ module Google
|
|
|
578
582
|
# @param current_document [::Google::Cloud::Firestore::V1::Precondition, ::Hash]
|
|
579
583
|
# An optional precondition on the document.
|
|
580
584
|
# The request will fail if this is set and not met by the target document.
|
|
585
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
586
|
+
# Optional. Any additional options for the request.
|
|
581
587
|
#
|
|
582
588
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
583
589
|
# @yieldparam response [::Google::Cloud::Firestore::V1::Document]
|
|
@@ -656,7 +662,7 @@ module Google
|
|
|
656
662
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
657
663
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
658
664
|
#
|
|
659
|
-
# @overload delete_document(name: nil, current_document: nil)
|
|
665
|
+
# @overload delete_document(name: nil, current_document: nil, request_options: nil)
|
|
660
666
|
# Pass arguments to `delete_document` via keyword arguments. Note that at
|
|
661
667
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
662
668
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -667,6 +673,8 @@ module Google
|
|
|
667
673
|
# @param current_document [::Google::Cloud::Firestore::V1::Precondition, ::Hash]
|
|
668
674
|
# An optional precondition on the document.
|
|
669
675
|
# The request will fail if this is set and not met by the target document.
|
|
676
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
677
|
+
# Optional. Any additional options for the request.
|
|
670
678
|
#
|
|
671
679
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
672
680
|
# @yieldparam response [::Google::Protobuf::Empty]
|
|
@@ -748,7 +756,7 @@ module Google
|
|
|
748
756
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
749
757
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
750
758
|
#
|
|
751
|
-
# @overload batch_get_documents(database: nil, documents: nil, mask: nil, transaction: nil, new_transaction: nil, read_time: nil)
|
|
759
|
+
# @overload batch_get_documents(database: nil, documents: nil, mask: nil, transaction: nil, new_transaction: nil, read_time: nil, request_options: nil)
|
|
752
760
|
# Pass arguments to `batch_get_documents` via keyword arguments. Note that at
|
|
753
761
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
754
762
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -785,6 +793,8 @@ module Google
|
|
|
785
793
|
# minute timestamp within the past 7 days.
|
|
786
794
|
#
|
|
787
795
|
# 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.
|
|
796
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
797
|
+
# Optional. Any additional options for the request.
|
|
788
798
|
#
|
|
789
799
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
790
800
|
# @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
|
|
@@ -866,7 +876,7 @@ module Google
|
|
|
866
876
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
867
877
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
868
878
|
#
|
|
869
|
-
# @overload begin_transaction(database: nil, options: nil)
|
|
879
|
+
# @overload begin_transaction(database: nil, options: nil, request_options: nil)
|
|
870
880
|
# Pass arguments to `begin_transaction` via keyword arguments. Note that at
|
|
871
881
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
872
882
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -877,6 +887,8 @@ module Google
|
|
|
877
887
|
# @param options [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
|
878
888
|
# The options for the transaction.
|
|
879
889
|
# Defaults to a read-write transaction.
|
|
890
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
891
|
+
# Optional. Any additional options for the request.
|
|
880
892
|
#
|
|
881
893
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
882
894
|
# @yieldparam response [::Google::Cloud::Firestore::V1::BeginTransactionResponse]
|
|
@@ -955,7 +967,7 @@ module Google
|
|
|
955
967
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
956
968
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
957
969
|
#
|
|
958
|
-
# @overload commit(database: nil, writes: nil, transaction: nil)
|
|
970
|
+
# @overload commit(database: nil, writes: nil, transaction: nil, request_options: nil)
|
|
959
971
|
# Pass arguments to `commit` via keyword arguments. Note that at
|
|
960
972
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
961
973
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -969,6 +981,8 @@ module Google
|
|
|
969
981
|
# Always executed atomically and in order.
|
|
970
982
|
# @param transaction [::String]
|
|
971
983
|
# If set, applies all writes in this transaction, and commits it.
|
|
984
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
985
|
+
# Optional. Any additional options for the request.
|
|
972
986
|
#
|
|
973
987
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
974
988
|
# @yieldparam response [::Google::Cloud::Firestore::V1::CommitResponse]
|
|
@@ -1047,7 +1061,7 @@ module Google
|
|
|
1047
1061
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1048
1062
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1049
1063
|
#
|
|
1050
|
-
# @overload rollback(database: nil, transaction: nil)
|
|
1064
|
+
# @overload rollback(database: nil, transaction: nil, request_options: nil)
|
|
1051
1065
|
# Pass arguments to `rollback` via keyword arguments. Note that at
|
|
1052
1066
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1053
1067
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1057,6 +1071,8 @@ module Google
|
|
|
1057
1071
|
# `projects/{project_id}/databases/{database_id}`.
|
|
1058
1072
|
# @param transaction [::String]
|
|
1059
1073
|
# Required. The transaction to roll back.
|
|
1074
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
1075
|
+
# Optional. Any additional options for the request.
|
|
1060
1076
|
#
|
|
1061
1077
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1062
1078
|
# @yieldparam response [::Google::Protobuf::Empty]
|
|
@@ -1135,7 +1151,7 @@ module Google
|
|
|
1135
1151
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1136
1152
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1137
1153
|
#
|
|
1138
|
-
# @overload run_query(parent: nil, structured_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil)
|
|
1154
|
+
# @overload run_query(parent: nil, structured_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil, request_options: nil)
|
|
1139
1155
|
# Pass arguments to `run_query` via keyword arguments. Note that at
|
|
1140
1156
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1141
1157
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1173,6 +1189,8 @@ module Google
|
|
|
1173
1189
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
|
1174
1190
|
# Optional. Explain options for the query. If set, additional query
|
|
1175
1191
|
# statistics will be returned. If not, only query results will be returned.
|
|
1192
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
1193
|
+
# Optional. Any additional options for the request.
|
|
1176
1194
|
#
|
|
1177
1195
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1178
1196
|
# @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::RunQueryResponse>]
|
|
@@ -1254,7 +1272,7 @@ module Google
|
|
|
1254
1272
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1255
1273
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1256
1274
|
#
|
|
1257
|
-
# @overload execute_pipeline(database: nil, structured_pipeline: nil, transaction: nil, new_transaction: nil, read_time: nil)
|
|
1275
|
+
# @overload execute_pipeline(database: nil, structured_pipeline: nil, transaction: nil, new_transaction: nil, read_time: nil, auto_commit_transaction: nil, request_options: nil)
|
|
1258
1276
|
# Pass arguments to `execute_pipeline` via keyword arguments. Note that at
|
|
1259
1277
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1260
1278
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1285,6 +1303,12 @@ module Google
|
|
|
1285
1303
|
# minute timestamp within the past 7 days.
|
|
1286
1304
|
#
|
|
1287
1305
|
# 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.
|
|
1306
|
+
# @param auto_commit_transaction [::Boolean]
|
|
1307
|
+
# Optional. Automatically commits the transaction after the pipeline has been
|
|
1308
|
+
# executed. Only permitted in combination with `transaction` or
|
|
1309
|
+
# `new_transaction`.
|
|
1310
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
1311
|
+
# Optional. Any additional options for the request.
|
|
1288
1312
|
#
|
|
1289
1313
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1290
1314
|
# @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::ExecutePipelineResponse>]
|
|
@@ -1332,13 +1356,13 @@ module Google
|
|
|
1332
1356
|
|
|
1333
1357
|
header_params = {}
|
|
1334
1358
|
if request.database
|
|
1335
|
-
regex_match = %r{^projects/(?<project_id>[^/]+)(
|
|
1359
|
+
regex_match = %r{^projects/(?<project_id>[^/]+)(?:/(?<__wildcard__>.*))?$}.match request.database
|
|
1336
1360
|
if regex_match
|
|
1337
1361
|
header_params["project_id"] = regex_match["project_id".to_s]
|
|
1338
1362
|
end
|
|
1339
1363
|
end
|
|
1340
1364
|
if request.database
|
|
1341
|
-
regex_match = %r{^projects/[^/]+/databases/(?<database_id>[^/]+)(
|
|
1365
|
+
regex_match = %r{^projects/[^/]+/databases/(?<database_id>[^/]+)(?:/(?<__wildcard__>.*))?$}.match request.database
|
|
1342
1366
|
if regex_match
|
|
1343
1367
|
header_params["database_id"] = regex_match["database_id".to_s]
|
|
1344
1368
|
end
|
|
@@ -1387,7 +1411,7 @@ module Google
|
|
|
1387
1411
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1388
1412
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1389
1413
|
#
|
|
1390
|
-
# @overload run_aggregation_query(parent: nil, structured_aggregation_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil)
|
|
1414
|
+
# @overload run_aggregation_query(parent: nil, structured_aggregation_query: nil, transaction: nil, new_transaction: nil, read_time: nil, explain_options: nil, request_options: nil)
|
|
1391
1415
|
# Pass arguments to `run_aggregation_query` via keyword arguments. Note that at
|
|
1392
1416
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1393
1417
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1425,6 +1449,8 @@ module Google
|
|
|
1425
1449
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
|
1426
1450
|
# Optional. Explain options for the query. If set, additional query
|
|
1427
1451
|
# statistics will be returned. If not, only query results will be returned.
|
|
1452
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
1453
|
+
# Optional. Any additional options for the request.
|
|
1428
1454
|
#
|
|
1429
1455
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1430
1456
|
# @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::RunAggregationQueryResponse>]
|
|
@@ -1508,7 +1534,7 @@ module Google
|
|
|
1508
1534
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1509
1535
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1510
1536
|
#
|
|
1511
|
-
# @overload partition_query(parent: nil, structured_query: nil, partition_count: nil, page_token: nil, page_size: nil, read_time: nil)
|
|
1537
|
+
# @overload partition_query(parent: nil, structured_query: nil, partition_count: nil, page_token: nil, page_size: nil, read_time: nil, request_options: nil)
|
|
1512
1538
|
# Pass arguments to `partition_query` via keyword arguments. Note that at
|
|
1513
1539
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1514
1540
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1560,6 +1586,8 @@ module Google
|
|
|
1560
1586
|
# This must be a microsecond precision timestamp within the past one hour,
|
|
1561
1587
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
|
1562
1588
|
# minute timestamp within the past 7 days.
|
|
1589
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
1590
|
+
# Optional. Any additional options for the request.
|
|
1563
1591
|
#
|
|
1564
1592
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1565
1593
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Firestore::V1::Cursor>]
|
|
@@ -1802,7 +1830,7 @@ module Google
|
|
|
1802
1830
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1803
1831
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1804
1832
|
#
|
|
1805
|
-
# @overload list_collection_ids(parent: nil, page_size: nil, page_token: nil, read_time: nil)
|
|
1833
|
+
# @overload list_collection_ids(parent: nil, page_size: nil, page_token: nil, read_time: nil, request_options: nil)
|
|
1806
1834
|
# Pass arguments to `list_collection_ids` via keyword arguments. Note that at
|
|
1807
1835
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1808
1836
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1812,6 +1840,9 @@ module Google
|
|
|
1812
1840
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
|
1813
1841
|
# For example:
|
|
1814
1842
|
# `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
|
|
1843
|
+
#
|
|
1844
|
+
# Use `projects/{project_id}/databases/{database_id}/documents` to list
|
|
1845
|
+
# top-level collections.
|
|
1815
1846
|
# @param page_size [::Integer]
|
|
1816
1847
|
# The maximum number of results to return.
|
|
1817
1848
|
# @param page_token [::String]
|
|
@@ -1823,6 +1854,8 @@ module Google
|
|
|
1823
1854
|
# This must be a microsecond precision timestamp within the past one hour,
|
|
1824
1855
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
|
1825
1856
|
# minute timestamp within the past 7 days.
|
|
1857
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
1858
|
+
# Optional. Any additional options for the request.
|
|
1826
1859
|
#
|
|
1827
1860
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1828
1861
|
# @yieldparam response [::Google::Cloud::Firestore::V1::ListCollectionIdsResponse]
|
|
@@ -1910,7 +1943,7 @@ module Google
|
|
|
1910
1943
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1911
1944
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1912
1945
|
#
|
|
1913
|
-
# @overload batch_write(database: nil, writes: nil, labels: nil)
|
|
1946
|
+
# @overload batch_write(database: nil, writes: nil, labels: nil, request_options: nil)
|
|
1914
1947
|
# Pass arguments to `batch_write` via keyword arguments. Note that at
|
|
1915
1948
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1916
1949
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1926,6 +1959,8 @@ module Google
|
|
|
1926
1959
|
# document more than once per request.
|
|
1927
1960
|
# @param labels [::Hash{::String => ::String}]
|
|
1928
1961
|
# Labels associated with this batch write.
|
|
1962
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
1963
|
+
# Optional. Any additional options for the request.
|
|
1929
1964
|
#
|
|
1930
1965
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1931
1966
|
# @yieldparam response [::Google::Cloud::Firestore::V1::BatchWriteResponse]
|
|
@@ -2004,7 +2039,7 @@ module Google
|
|
|
2004
2039
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2005
2040
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
2006
2041
|
#
|
|
2007
|
-
# @overload create_document(parent: nil, collection_id: nil, document_id: nil, document: nil, mask: nil)
|
|
2042
|
+
# @overload create_document(parent: nil, collection_id: nil, document_id: nil, document: nil, mask: nil, request_options: nil)
|
|
2008
2043
|
# Pass arguments to `create_document` via keyword arguments. Note that at
|
|
2009
2044
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2010
2045
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -2027,6 +2062,8 @@ module Google
|
|
|
2027
2062
|
#
|
|
2028
2063
|
# If the document has a field that is not present in this mask, that field
|
|
2029
2064
|
# will not be returned in the response.
|
|
2065
|
+
# @param request_options [::Google::Cloud::Firestore::V1::RequestOptions, ::Hash]
|
|
2066
|
+
# Optional. Any additional options for the request.
|
|
2030
2067
|
#
|
|
2031
2068
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2032
2069
|
# @yieldparam response [::Google::Cloud::Firestore::V1::Document]
|
|
@@ -2191,6 +2228,7 @@ module Google
|
|
|
2191
2228
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
2192
2229
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
2193
2230
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
2231
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
2194
2232
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
2195
2233
|
# trigger a retry.
|
|
2196
2234
|
# @return [::Hash]
|
|
@@ -2274,6 +2312,7 @@ module Google
|
|
|
2274
2312
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
2275
2313
|
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
2276
2314
|
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
2315
|
+
# * `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
|
|
2277
2316
|
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
2278
2317
|
# trigger a retry.
|
|
2279
2318
|
#
|