google-cloud-firestore-v1 2.0.1 → 2.1.1
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
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 81c9d11613e472aa34b1bea0ea9d03efbf44e782b2b202479348c148def227b2
|
4
|
+
data.tar.gz: 83f9384bd014c4acbf26594f96dd34b265aee4b5f5fd760b1bb47ec507540abd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d3a92fab78bda7d1ec61de675d8dbb9de958dc8182796ceff78de80b22575fa7a77ec604cc47ca7ae42a5d5855b3391a7c99c65243f476c45fe55d17b0ec812c
|
7
|
+
data.tar.gz: d9050a46959b1f7a0ab3dfa53a96b78935686d61909ea757193efae3ca1fb0ad65167036767e95ace7f62a068f42afd32aebbf5dc1d76bb59f0124c1568adbb4
|
@@ -310,7 +310,7 @@ module Google
|
|
310
310
|
# @param transaction [::String]
|
311
311
|
# Reads the document in a transaction.
|
312
312
|
#
|
313
|
-
# Note: The following
|
313
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `read_time`. 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.
|
314
314
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
315
315
|
# Reads the version of the document at the given time.
|
316
316
|
#
|
@@ -318,7 +318,7 @@ module Google
|
|
318
318
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
319
319
|
# minute timestamp within the past 7 days.
|
320
320
|
#
|
321
|
-
# Note: The following
|
321
|
+
# 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.
|
322
322
|
#
|
323
323
|
# @yield [response, operation] Access the result along with the RPC operation
|
324
324
|
# @yieldparam response [::Google::Cloud::Firestore::V1::Document]
|
@@ -443,7 +443,7 @@ module Google
|
|
443
443
|
# @param transaction [::String]
|
444
444
|
# Perform the read as part of an already active transaction.
|
445
445
|
#
|
446
|
-
# Note: The following
|
446
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `read_time`. 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.
|
447
447
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
448
448
|
# Perform the read at the provided time.
|
449
449
|
#
|
@@ -451,7 +451,7 @@ module Google
|
|
451
451
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
452
452
|
# minute timestamp within the past 7 days.
|
453
453
|
#
|
454
|
-
# Note: The following
|
454
|
+
# 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.
|
455
455
|
# @param show_missing [::Boolean]
|
456
456
|
# If the list should show missing documents.
|
457
457
|
#
|
@@ -764,14 +764,14 @@ module Google
|
|
764
764
|
# @param transaction [::String]
|
765
765
|
# Reads documents in a transaction.
|
766
766
|
#
|
767
|
-
# Note: The following
|
767
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. 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.
|
768
768
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
769
769
|
# Starts a new transaction and reads the documents.
|
770
770
|
# Defaults to a read-only transaction.
|
771
771
|
# The new transaction ID will be returned as the first response in the
|
772
772
|
# stream.
|
773
773
|
#
|
774
|
-
# Note: The following
|
774
|
+
# Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. 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.
|
775
775
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
776
776
|
# Reads documents as they were at the given time.
|
777
777
|
#
|
@@ -779,7 +779,7 @@ module Google
|
|
779
779
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
780
780
|
# minute timestamp within the past 7 days.
|
781
781
|
#
|
782
|
-
# Note: The following
|
782
|
+
# 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.
|
783
783
|
#
|
784
784
|
# @yield [response, operation] Access the result along with the RPC operation
|
785
785
|
# @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
|
@@ -1149,14 +1149,14 @@ module Google
|
|
1149
1149
|
#
|
1150
1150
|
# The value here is the opaque transaction ID to execute the query in.
|
1151
1151
|
#
|
1152
|
-
# Note: The following
|
1152
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. 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.
|
1153
1153
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1154
1154
|
# Starts a new transaction and reads the documents.
|
1155
1155
|
# Defaults to a read-only transaction.
|
1156
1156
|
# The new transaction ID will be returned as the first response in the
|
1157
1157
|
# stream.
|
1158
1158
|
#
|
1159
|
-
# Note: The following
|
1159
|
+
# Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. 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.
|
1160
1160
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1161
1161
|
# Reads documents as they were at the given time.
|
1162
1162
|
#
|
@@ -1164,7 +1164,7 @@ module Google
|
|
1164
1164
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1165
1165
|
# minute timestamp within the past 7 days.
|
1166
1166
|
#
|
1167
|
-
# Note: The following
|
1167
|
+
# 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.
|
1168
1168
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1169
1169
|
# Optional. Explain options for the query. If set, additional query
|
1170
1170
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -1280,14 +1280,14 @@ module Google
|
|
1280
1280
|
#
|
1281
1281
|
# The value here is the opaque transaction ID to execute the query in.
|
1282
1282
|
#
|
1283
|
-
# Note: The following
|
1283
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. 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.
|
1284
1284
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1285
1285
|
# Starts a new transaction as part of the query, defaulting to read-only.
|
1286
1286
|
#
|
1287
1287
|
# The new transaction ID will be returned as the first response in the
|
1288
1288
|
# stream.
|
1289
1289
|
#
|
1290
|
-
# Note: The following
|
1290
|
+
# Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. 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.
|
1291
1291
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1292
1292
|
# Executes the query at the given timestamp.
|
1293
1293
|
#
|
@@ -1295,7 +1295,7 @@ module Google
|
|
1295
1295
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1296
1296
|
# minute timestamp within the past 7 days.
|
1297
1297
|
#
|
1298
|
-
# Note: The following
|
1298
|
+
# 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.
|
1299
1299
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1300
1300
|
# Optional. Explain options for the query. If set, additional query
|
1301
1301
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -296,7 +296,7 @@ module Google
|
|
296
296
|
# @param transaction [::String]
|
297
297
|
# Reads the document in a transaction.
|
298
298
|
#
|
299
|
-
# Note: The following
|
299
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `read_time`. 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.
|
300
300
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
301
301
|
# Reads the version of the document at the given time.
|
302
302
|
#
|
@@ -304,7 +304,7 @@ module Google
|
|
304
304
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
305
305
|
# minute timestamp within the past 7 days.
|
306
306
|
#
|
307
|
-
# Note: The following
|
307
|
+
# 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.
|
308
308
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
309
309
|
# @yieldparam result [::Google::Cloud::Firestore::V1::Document]
|
310
310
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -422,7 +422,7 @@ module Google
|
|
422
422
|
# @param transaction [::String]
|
423
423
|
# Perform the read as part of an already active transaction.
|
424
424
|
#
|
425
|
-
# Note: The following
|
425
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `read_time`. 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.
|
426
426
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
427
427
|
# Perform the read at the provided time.
|
428
428
|
#
|
@@ -430,7 +430,7 @@ module Google
|
|
430
430
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
431
431
|
# minute timestamp within the past 7 days.
|
432
432
|
#
|
433
|
-
# Note: The following
|
433
|
+
# 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.
|
434
434
|
# @param show_missing [::Boolean]
|
435
435
|
# If the list should show missing documents.
|
436
436
|
#
|
@@ -719,14 +719,14 @@ module Google
|
|
719
719
|
# @param transaction [::String]
|
720
720
|
# Reads documents in a transaction.
|
721
721
|
#
|
722
|
-
# Note: The following
|
722
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. 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.
|
723
723
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
724
724
|
# Starts a new transaction and reads the documents.
|
725
725
|
# Defaults to a read-only transaction.
|
726
726
|
# The new transaction ID will be returned as the first response in the
|
727
727
|
# stream.
|
728
728
|
#
|
729
|
-
# Note: The following
|
729
|
+
# Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. 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.
|
730
730
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
731
731
|
# Reads documents as they were at the given time.
|
732
732
|
#
|
@@ -734,7 +734,7 @@ module Google
|
|
734
734
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
735
735
|
# minute timestamp within the past 7 days.
|
736
736
|
#
|
737
|
-
# Note: The following
|
737
|
+
# 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.
|
738
738
|
# @return [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
|
739
739
|
#
|
740
740
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
@@ -1078,14 +1078,14 @@ module Google
|
|
1078
1078
|
#
|
1079
1079
|
# The value here is the opaque transaction ID to execute the query in.
|
1080
1080
|
#
|
1081
|
-
# Note: The following
|
1081
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. 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.
|
1082
1082
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1083
1083
|
# Starts a new transaction and reads the documents.
|
1084
1084
|
# Defaults to a read-only transaction.
|
1085
1085
|
# The new transaction ID will be returned as the first response in the
|
1086
1086
|
# stream.
|
1087
1087
|
#
|
1088
|
-
# Note: The following
|
1088
|
+
# Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. 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.
|
1089
1089
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1090
1090
|
# Reads documents as they were at the given time.
|
1091
1091
|
#
|
@@ -1093,7 +1093,7 @@ module Google
|
|
1093
1093
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1094
1094
|
# minute timestamp within the past 7 days.
|
1095
1095
|
#
|
1096
|
-
# Note: The following
|
1096
|
+
# 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.
|
1097
1097
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1098
1098
|
# Optional. Explain options for the query. If set, additional query
|
1099
1099
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -1204,14 +1204,14 @@ module Google
|
|
1204
1204
|
#
|
1205
1205
|
# The value here is the opaque transaction ID to execute the query in.
|
1206
1206
|
#
|
1207
|
-
# Note: The following
|
1207
|
+
# Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. 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.
|
1208
1208
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1209
1209
|
# Starts a new transaction as part of the query, defaulting to read-only.
|
1210
1210
|
#
|
1211
1211
|
# The new transaction ID will be returned as the first response in the
|
1212
1212
|
# stream.
|
1213
1213
|
#
|
1214
|
-
# Note: The following
|
1214
|
+
# Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. 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.
|
1215
1215
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1216
1216
|
# Executes the query at the given timestamp.
|
1217
1217
|
#
|
@@ -1219,7 +1219,7 @@ module Google
|
|
1219
1219
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1220
1220
|
# minute timestamp within the past 7 days.
|
1221
1221
|
#
|
1222
|
-
# Note: The following
|
1222
|
+
# 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.
|
1223
1223
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1224
1224
|
# Optional. Explain options for the query. If set, additional query
|
1225
1225
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -244,7 +244,7 @@ module Google
|
|
244
244
|
# @yieldparam chunk [::String] The chunk of data received during server streaming.
|
245
245
|
#
|
246
246
|
# @return [::Gapic::Rest::TransportOperation]
|
247
|
-
def batch_get_documents
|
247
|
+
def batch_get_documents(request_pb, options = nil, &)
|
248
248
|
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
249
249
|
|
250
250
|
verb, uri, query_string_params, body = ServiceStub.transcode_batch_get_documents_request request_pb
|
@@ -262,7 +262,7 @@ module Google
|
|
262
262
|
method_name: "batch_get_documents",
|
263
263
|
options: options,
|
264
264
|
is_server_streaming: true,
|
265
|
-
&
|
265
|
+
&
|
266
266
|
)
|
267
267
|
::Gapic::Rest::TransportOperation.new response
|
268
268
|
end
|
@@ -398,7 +398,7 @@ module Google
|
|
398
398
|
# @yieldparam chunk [::String] The chunk of data received during server streaming.
|
399
399
|
#
|
400
400
|
# @return [::Gapic::Rest::TransportOperation]
|
401
|
-
def run_query
|
401
|
+
def run_query(request_pb, options = nil, &)
|
402
402
|
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
403
403
|
|
404
404
|
verb, uri, query_string_params, body = ServiceStub.transcode_run_query_request request_pb
|
@@ -416,7 +416,7 @@ module Google
|
|
416
416
|
method_name: "run_query",
|
417
417
|
options: options,
|
418
418
|
is_server_streaming: true,
|
419
|
-
&
|
419
|
+
&
|
420
420
|
)
|
421
421
|
::Gapic::Rest::TransportOperation.new response
|
422
422
|
end
|
@@ -432,7 +432,7 @@ module Google
|
|
432
432
|
# @yieldparam chunk [::String] The chunk of data received during server streaming.
|
433
433
|
#
|
434
434
|
# @return [::Gapic::Rest::TransportOperation]
|
435
|
-
def run_aggregation_query
|
435
|
+
def run_aggregation_query(request_pb, options = nil, &)
|
436
436
|
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
437
437
|
|
438
438
|
verb, uri, query_string_params, body = ServiceStub.transcode_run_aggregation_query_request request_pb
|
@@ -450,7 +450,7 @@ module Google
|
|
450
450
|
method_name: "run_aggregation_query",
|
451
451
|
options: options,
|
452
452
|
is_server_streaming: true,
|
453
|
-
&
|
453
|
+
&
|
454
454
|
)
|
455
455
|
::Gapic::Rest::TransportOperation.new response
|
456
456
|
end
|
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
|
+
version: 2.1.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
@@ -13,22 +13,16 @@ dependencies:
|
|
13
13
|
name: gapic-common
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
15
15
|
requirements:
|
16
|
-
- - "
|
17
|
-
- !ruby/object:Gem::Version
|
18
|
-
version: 0.25.0
|
19
|
-
- - "<"
|
16
|
+
- - "~>"
|
20
17
|
- !ruby/object:Gem::Version
|
21
|
-
version:
|
18
|
+
version: '1.0'
|
22
19
|
type: :runtime
|
23
20
|
prerelease: false
|
24
21
|
version_requirements: !ruby/object:Gem::Requirement
|
25
22
|
requirements:
|
26
|
-
- - "
|
27
|
-
- !ruby/object:Gem::Version
|
28
|
-
version: 0.25.0
|
29
|
-
- - "<"
|
23
|
+
- - "~>"
|
30
24
|
- !ruby/object:Gem::Version
|
31
|
-
version:
|
25
|
+
version: '1.0'
|
32
26
|
- !ruby/object:Gem::Dependency
|
33
27
|
name: google-cloud-errors
|
34
28
|
requirement: !ruby/object:Gem::Requirement
|
@@ -47,22 +41,16 @@ dependencies:
|
|
47
41
|
name: google-cloud-location
|
48
42
|
requirement: !ruby/object:Gem::Requirement
|
49
43
|
requirements:
|
50
|
-
- - "
|
51
|
-
- !ruby/object:Gem::Version
|
52
|
-
version: '0.7'
|
53
|
-
- - "<"
|
44
|
+
- - "~>"
|
54
45
|
- !ruby/object:Gem::Version
|
55
|
-
version:
|
46
|
+
version: '1.0'
|
56
47
|
type: :runtime
|
57
48
|
prerelease: false
|
58
49
|
version_requirements: !ruby/object:Gem::Requirement
|
59
50
|
requirements:
|
60
|
-
- - "
|
61
|
-
- !ruby/object:Gem::Version
|
62
|
-
version: '0.7'
|
63
|
-
- - "<"
|
51
|
+
- - "~>"
|
64
52
|
- !ruby/object:Gem::Version
|
65
|
-
version:
|
53
|
+
version: '1.0'
|
66
54
|
description: Cloud Firestore is a NoSQL document database built for automatic scaling,
|
67
55
|
high performance, and ease of application development. Note that google-cloud-firestore-v1
|
68
56
|
is a version-specific client library. For most uses, we recommend installing the
|
@@ -128,14 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
128
116
|
requirements:
|
129
117
|
- - ">="
|
130
118
|
- !ruby/object:Gem::Version
|
131
|
-
version: '3.
|
119
|
+
version: '3.1'
|
132
120
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
133
121
|
requirements:
|
134
122
|
- - ">="
|
135
123
|
- !ruby/object:Gem::Version
|
136
124
|
version: '0'
|
137
125
|
requirements: []
|
138
|
-
rubygems_version: 3.6.
|
126
|
+
rubygems_version: 3.6.9
|
139
127
|
specification_version: 4
|
140
128
|
summary: Accesses the NoSQL document database built for automatic scaling, high performance,
|
141
129
|
and ease of application development.
|