google-cloud-firestore-v1 1.2.0 → 2.0.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 -1
- data/lib/google/cloud/firestore/v1/firestore/client.rb +33 -0
- data/lib/google/cloud/firestore/v1/firestore/rest/client.rb +35 -4
- data/lib/google/cloud/firestore/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +8 -0
- data/proto_docs/google/firestore/v1/common.rb +8 -0
- data/proto_docs/google/firestore/v1/document.rb +22 -0
- data/proto_docs/google/firestore/v1/firestore.rb +52 -0
- data/proto_docs/google/firestore/v1/query.rb +12 -0
- data/proto_docs/google/firestore/v1/write.rb +18 -0
- data/proto_docs/google/protobuf/struct.rb +12 -0
- metadata +6 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 447f6a019fc7767a6d6475e12b78396f3c535e147c448f190cd5833ff082dc3d
|
4
|
+
data.tar.gz: a363bf22426de3fae9ea1b7d3f9c35f44bf0d8bf6fafa0a0fe29b56adcf9ab42
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8bb5c27f0d267643f68a8f73f8b3738a27db3d2f6c4d44b768ba07268dff24a975574e8cbf5dc06332dd79028943b5a36c23cd3cd520c9ac80c0b10815881f20
|
7
|
+
data.tar.gz: 78f1dfb8a0e111cafbab6a3dc9eb5a48c39ef14cf95a0de1b2aa9d2c73c3a170cb223069add4100557e2e94673e7cb56d03a243b99512ad0fb0c4ae6bab7e2dd
|
data/README.md
CHANGED
@@ -86,7 +86,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
|
|
86
86
|
|
87
87
|
## Supported Ruby Versions
|
88
88
|
|
89
|
-
This library is supported on Ruby
|
89
|
+
This library is supported on Ruby 3.0+.
|
90
90
|
|
91
91
|
Google provides official support for Ruby versions that are actively supported
|
92
92
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
@@ -309,6 +309,8 @@ module Google
|
|
309
309
|
# will not be returned in the response.
|
310
310
|
# @param transaction [::String]
|
311
311
|
# Reads the document in a transaction.
|
312
|
+
#
|
313
|
+
# Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
312
314
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
313
315
|
# Reads the version of the document at the given time.
|
314
316
|
#
|
@@ -316,6 +318,8 @@ module Google
|
|
316
318
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
317
319
|
# minute timestamp within the past 7 days.
|
318
320
|
#
|
321
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
322
|
+
#
|
319
323
|
# @yield [response, operation] Access the result along with the RPC operation
|
320
324
|
# @yieldparam response [::Google::Cloud::Firestore::V1::Document]
|
321
325
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
@@ -438,12 +442,16 @@ module Google
|
|
438
442
|
# will not be returned in the response.
|
439
443
|
# @param transaction [::String]
|
440
444
|
# Perform the read as part of an already active transaction.
|
445
|
+
#
|
446
|
+
# Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
441
447
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
442
448
|
# Perform the read at the provided time.
|
443
449
|
#
|
444
450
|
# This must be a microsecond precision timestamp within the past one hour,
|
445
451
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
446
452
|
# minute timestamp within the past 7 days.
|
453
|
+
#
|
454
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
447
455
|
# @param show_missing [::Boolean]
|
448
456
|
# If the list should show missing documents.
|
449
457
|
#
|
@@ -755,11 +763,15 @@ module Google
|
|
755
763
|
# not be returned in the response.
|
756
764
|
# @param transaction [::String]
|
757
765
|
# Reads documents in a transaction.
|
766
|
+
#
|
767
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
758
768
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
759
769
|
# Starts a new transaction and reads the documents.
|
760
770
|
# Defaults to a read-only transaction.
|
761
771
|
# The new transaction ID will be returned as the first response in the
|
762
772
|
# stream.
|
773
|
+
#
|
774
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
763
775
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
764
776
|
# Reads documents as they were at the given time.
|
765
777
|
#
|
@@ -767,6 +779,8 @@ module Google
|
|
767
779
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
768
780
|
# minute timestamp within the past 7 days.
|
769
781
|
#
|
782
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
783
|
+
#
|
770
784
|
# @yield [response, operation] Access the result along with the RPC operation
|
771
785
|
# @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
|
772
786
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
@@ -1134,17 +1148,23 @@ module Google
|
|
1134
1148
|
# Run the query within an already active transaction.
|
1135
1149
|
#
|
1136
1150
|
# The value here is the opaque transaction ID to execute the query in.
|
1151
|
+
#
|
1152
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1137
1153
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1138
1154
|
# Starts a new transaction and reads the documents.
|
1139
1155
|
# Defaults to a read-only transaction.
|
1140
1156
|
# The new transaction ID will be returned as the first response in the
|
1141
1157
|
# stream.
|
1158
|
+
#
|
1159
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1142
1160
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1143
1161
|
# Reads documents as they were at the given time.
|
1144
1162
|
#
|
1145
1163
|
# This must be a microsecond precision timestamp within the past one hour,
|
1146
1164
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1147
1165
|
# minute timestamp within the past 7 days.
|
1166
|
+
#
|
1167
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1148
1168
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1149
1169
|
# Optional. Explain options for the query. If set, additional query
|
1150
1170
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -1259,17 +1279,23 @@ module Google
|
|
1259
1279
|
# Run the aggregation within an already active transaction.
|
1260
1280
|
#
|
1261
1281
|
# The value here is the opaque transaction ID to execute the query in.
|
1282
|
+
#
|
1283
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1262
1284
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1263
1285
|
# Starts a new transaction as part of the query, defaulting to read-only.
|
1264
1286
|
#
|
1265
1287
|
# The new transaction ID will be returned as the first response in the
|
1266
1288
|
# stream.
|
1289
|
+
#
|
1290
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1267
1291
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1268
1292
|
# Executes the query at the given timestamp.
|
1269
1293
|
#
|
1270
1294
|
# This must be a microsecond precision timestamp within the past one hour,
|
1271
1295
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1272
1296
|
# minute timestamp within the past 7 days.
|
1297
|
+
#
|
1298
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1273
1299
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1274
1300
|
# Optional. Explain options for the query. If set, additional query
|
1275
1301
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -1987,6 +2013,13 @@ module Google
|
|
1987
2013
|
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
|
1988
2014
|
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
|
1989
2015
|
# * (`nil`) indicating no credentials
|
2016
|
+
#
|
2017
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
2018
|
+
# external source for authentication to Google Cloud, you must validate it before
|
2019
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
2020
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
2021
|
+
# For more information, refer to [Validate credential configurations from external
|
2022
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
1990
2023
|
# @return [::Object]
|
1991
2024
|
# @!attribute [rw] scope
|
1992
2025
|
# The OAuth scopes
|
@@ -295,12 +295,16 @@ module Google
|
|
295
295
|
# will not be returned in the response.
|
296
296
|
# @param transaction [::String]
|
297
297
|
# Reads the document in a transaction.
|
298
|
+
#
|
299
|
+
# Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
298
300
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
299
301
|
# Reads the version of the document at the given time.
|
300
302
|
#
|
301
303
|
# This must be a microsecond precision timestamp within the past one hour,
|
302
304
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
303
305
|
# minute timestamp within the past 7 days.
|
306
|
+
#
|
307
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
304
308
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
305
309
|
# @yieldparam result [::Google::Cloud::Firestore::V1::Document]
|
306
310
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -417,12 +421,16 @@ module Google
|
|
417
421
|
# will not be returned in the response.
|
418
422
|
# @param transaction [::String]
|
419
423
|
# Perform the read as part of an already active transaction.
|
424
|
+
#
|
425
|
+
# Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
420
426
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
421
427
|
# Perform the read at the provided time.
|
422
428
|
#
|
423
429
|
# This must be a microsecond precision timestamp within the past one hour,
|
424
430
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
425
431
|
# minute timestamp within the past 7 days.
|
432
|
+
#
|
433
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
426
434
|
# @param show_missing [::Boolean]
|
427
435
|
# If the list should show missing documents.
|
428
436
|
#
|
@@ -710,17 +718,23 @@ module Google
|
|
710
718
|
# not be returned in the response.
|
711
719
|
# @param transaction [::String]
|
712
720
|
# Reads documents in a transaction.
|
721
|
+
#
|
722
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
713
723
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
714
724
|
# Starts a new transaction and reads the documents.
|
715
725
|
# Defaults to a read-only transaction.
|
716
726
|
# The new transaction ID will be returned as the first response in the
|
717
727
|
# stream.
|
728
|
+
#
|
729
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
718
730
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
719
731
|
# Reads documents as they were at the given time.
|
720
732
|
#
|
721
733
|
# This must be a microsecond precision timestamp within the past one hour,
|
722
734
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
723
735
|
# minute timestamp within the past 7 days.
|
736
|
+
#
|
737
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
724
738
|
# @return [::Enumerable<::Google::Cloud::Firestore::V1::BatchGetDocumentsResponse>]
|
725
739
|
#
|
726
740
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
@@ -1063,17 +1077,23 @@ module Google
|
|
1063
1077
|
# Run the query within an already active transaction.
|
1064
1078
|
#
|
1065
1079
|
# The value here is the opaque transaction ID to execute the query in.
|
1080
|
+
#
|
1081
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1066
1082
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1067
1083
|
# Starts a new transaction and reads the documents.
|
1068
1084
|
# Defaults to a read-only transaction.
|
1069
1085
|
# The new transaction ID will be returned as the first response in the
|
1070
1086
|
# stream.
|
1087
|
+
#
|
1088
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1071
1089
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1072
1090
|
# Reads documents as they were at the given time.
|
1073
1091
|
#
|
1074
1092
|
# This must be a microsecond precision timestamp within the past one hour,
|
1075
1093
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1076
1094
|
# minute timestamp within the past 7 days.
|
1095
|
+
#
|
1096
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1077
1097
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1078
1098
|
# Optional. Explain options for the query. If set, additional query
|
1079
1099
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -1183,17 +1203,23 @@ module Google
|
|
1183
1203
|
# Run the aggregation within an already active transaction.
|
1184
1204
|
#
|
1185
1205
|
# The value here is the opaque transaction ID to execute the query in.
|
1206
|
+
#
|
1207
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1186
1208
|
# @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
|
1187
1209
|
# Starts a new transaction as part of the query, defaulting to read-only.
|
1188
1210
|
#
|
1189
1211
|
# The new transaction ID will be returned as the first response in the
|
1190
1212
|
# stream.
|
1213
|
+
#
|
1214
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1191
1215
|
# @param read_time [::Google::Protobuf::Timestamp, ::Hash]
|
1192
1216
|
# Executes the query at the given timestamp.
|
1193
1217
|
#
|
1194
1218
|
# This must be a microsecond precision timestamp within the past one hour,
|
1195
1219
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1196
1220
|
# minute timestamp within the past 7 days.
|
1221
|
+
#
|
1222
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
1197
1223
|
# @param explain_options [::Google::Cloud::Firestore::V1::ExplainOptions, ::Hash]
|
1198
1224
|
# Optional. Explain options for the query. If set, additional query
|
1199
1225
|
# statistics will be returned. If not, only query results will be returned.
|
@@ -1426,10 +1452,10 @@ module Google
|
|
1426
1452
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
1427
1453
|
# minute timestamp within the past 7 days.
|
1428
1454
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
1429
|
-
# @yieldparam result [::
|
1455
|
+
# @yieldparam result [::Google::Cloud::Firestore::V1::ListCollectionIdsResponse]
|
1430
1456
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1431
1457
|
#
|
1432
|
-
# @return [::
|
1458
|
+
# @return [::Google::Cloud::Firestore::V1::ListCollectionIdsResponse]
|
1433
1459
|
#
|
1434
1460
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1435
1461
|
#
|
@@ -1477,9 +1503,7 @@ module Google
|
|
1477
1503
|
retry_policy: @config.retry_policy
|
1478
1504
|
|
1479
1505
|
@firestore_stub.list_collection_ids request, options do |result, operation|
|
1480
|
-
result = ::Gapic::Rest::PagedEnumerable.new @firestore_stub, :list_collection_ids, "collection_ids", request, result, options
|
1481
1506
|
yield result, operation if block_given?
|
1482
|
-
throw :response, result
|
1483
1507
|
end
|
1484
1508
|
rescue ::Gapic::Rest::Error => e
|
1485
1509
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -1717,6 +1741,13 @@ module Google
|
|
1717
1741
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
1718
1742
|
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
1719
1743
|
# * (`nil`) indicating no credentials
|
1744
|
+
#
|
1745
|
+
# Warning: If you accept a credential configuration (JSON file or Hash) from an
|
1746
|
+
# external source for authentication to Google Cloud, you must validate it before
|
1747
|
+
# providing it to a Google API client library. Providing an unvalidated credential
|
1748
|
+
# configuration to Google APIs can compromise the security of your systems and data.
|
1749
|
+
# For more information, refer to [Validate credential configurations from external
|
1750
|
+
# sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
|
1720
1751
|
# @return [::Object]
|
1721
1752
|
# @!attribute [rw] scope
|
1722
1753
|
# The OAuth scopes
|
@@ -409,6 +409,14 @@ module Google
|
|
409
409
|
# @return [::Array<::String>]
|
410
410
|
# An allowlist of the fully qualified names of RPCs that should be included
|
411
411
|
# on public client surfaces.
|
412
|
+
# @!attribute [rw] generate_omitted_as_internal
|
413
|
+
# @return [::Boolean]
|
414
|
+
# Setting this to true indicates to the client generators that methods
|
415
|
+
# that would be excluded from the generation should instead be generated
|
416
|
+
# in a way that indicates these methods should not be consumed by
|
417
|
+
# end users. How this is expressed is up to individual language
|
418
|
+
# implementations to decide. Some examples may be: added annotations,
|
419
|
+
# obfuscated identifiers, or other language idiomatic patterns.
|
412
420
|
class SelectiveGapicGeneration
|
413
421
|
include ::Google::Protobuf::MessageExts
|
414
422
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -42,10 +42,14 @@ module Google
|
|
42
42
|
# @return [::Boolean]
|
43
43
|
# When set to `true`, the target document must exist.
|
44
44
|
# When set to `false`, the target document must not exist.
|
45
|
+
#
|
46
|
+
# Note: The following fields are mutually exclusive: `exists`, `update_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
45
47
|
# @!attribute [rw] update_time
|
46
48
|
# @return [::Google::Protobuf::Timestamp]
|
47
49
|
# When set, the target document must exist and have been last updated at
|
48
50
|
# that time. Timestamp must be microsecond aligned.
|
51
|
+
#
|
52
|
+
# Note: The following fields are mutually exclusive: `update_time`, `exists`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
49
53
|
class Precondition
|
50
54
|
include ::Google::Protobuf::MessageExts
|
51
55
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -55,9 +59,13 @@ module Google
|
|
55
59
|
# @!attribute [rw] read_only
|
56
60
|
# @return [::Google::Cloud::Firestore::V1::TransactionOptions::ReadOnly]
|
57
61
|
# The transaction can only be used for read operations.
|
62
|
+
#
|
63
|
+
# Note: The following fields are mutually exclusive: `read_only`, `read_write`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
58
64
|
# @!attribute [rw] read_write
|
59
65
|
# @return [::Google::Cloud::Firestore::V1::TransactionOptions::ReadWrite]
|
60
66
|
# The transaction can be used for both read and write operations.
|
67
|
+
#
|
68
|
+
# Note: The following fields are mutually exclusive: `read_write`, `read_only`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
61
69
|
class TransactionOptions
|
62
70
|
include ::Google::Protobuf::MessageExts
|
63
71
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -86,21 +86,31 @@ module Google
|
|
86
86
|
# @!attribute [rw] null_value
|
87
87
|
# @return [::Google::Protobuf::NullValue]
|
88
88
|
# A null value.
|
89
|
+
#
|
90
|
+
# Note: The following fields are mutually exclusive: `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
89
91
|
# @!attribute [rw] boolean_value
|
90
92
|
# @return [::Boolean]
|
91
93
|
# A boolean value.
|
94
|
+
#
|
95
|
+
# Note: The following fields are mutually exclusive: `boolean_value`, `null_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
92
96
|
# @!attribute [rw] integer_value
|
93
97
|
# @return [::Integer]
|
94
98
|
# An integer value.
|
99
|
+
#
|
100
|
+
# Note: The following fields are mutually exclusive: `integer_value`, `null_value`, `boolean_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
95
101
|
# @!attribute [rw] double_value
|
96
102
|
# @return [::Float]
|
97
103
|
# A double value.
|
104
|
+
#
|
105
|
+
# Note: The following fields are mutually exclusive: `double_value`, `null_value`, `boolean_value`, `integer_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
98
106
|
# @!attribute [rw] timestamp_value
|
99
107
|
# @return [::Google::Protobuf::Timestamp]
|
100
108
|
# A timestamp value.
|
101
109
|
#
|
102
110
|
# Precise only to microseconds. When stored, any additional precision is
|
103
111
|
# rounded down.
|
112
|
+
#
|
113
|
+
# Note: The following fields are mutually exclusive: `timestamp_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
104
114
|
# @!attribute [rw] string_value
|
105
115
|
# @return [::String]
|
106
116
|
# A string value.
|
@@ -108,28 +118,40 @@ module Google
|
|
108
118
|
# The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.
|
109
119
|
# Only the first 1,500 bytes of the UTF-8 representation are considered by
|
110
120
|
# queries.
|
121
|
+
#
|
122
|
+
# Note: The following fields are mutually exclusive: `string_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
111
123
|
# @!attribute [rw] bytes_value
|
112
124
|
# @return [::String]
|
113
125
|
# A bytes value.
|
114
126
|
#
|
115
127
|
# Must not exceed 1 MiB - 89 bytes.
|
116
128
|
# Only the first 1,500 bytes are considered by queries.
|
129
|
+
#
|
130
|
+
# Note: The following fields are mutually exclusive: `bytes_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
117
131
|
# @!attribute [rw] reference_value
|
118
132
|
# @return [::String]
|
119
133
|
# A reference to a document. For example:
|
120
134
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
135
|
+
#
|
136
|
+
# Note: The following fields are mutually exclusive: `reference_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
121
137
|
# @!attribute [rw] geo_point_value
|
122
138
|
# @return [::Google::Type::LatLng]
|
123
139
|
# A geo point value representing a point on the surface of Earth.
|
140
|
+
#
|
141
|
+
# Note: The following fields are mutually exclusive: `geo_point_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
124
142
|
# @!attribute [rw] array_value
|
125
143
|
# @return [::Google::Cloud::Firestore::V1::ArrayValue]
|
126
144
|
# An array value.
|
127
145
|
#
|
128
146
|
# Cannot directly contain another array value, though can contain a
|
129
147
|
# map which contains another array.
|
148
|
+
#
|
149
|
+
# Note: The following fields are mutually exclusive: `array_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
130
150
|
# @!attribute [rw] map_value
|
131
151
|
# @return [::Google::Cloud::Firestore::V1::MapValue]
|
132
152
|
# A map value.
|
153
|
+
#
|
154
|
+
# Note: The following fields are mutually exclusive: `map_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
133
155
|
class Value
|
134
156
|
include ::Google::Protobuf::MessageExts
|
135
157
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -36,6 +36,8 @@ module Google
|
|
36
36
|
# @!attribute [rw] transaction
|
37
37
|
# @return [::String]
|
38
38
|
# Reads the document in a transaction.
|
39
|
+
#
|
40
|
+
# Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
39
41
|
# @!attribute [rw] read_time
|
40
42
|
# @return [::Google::Protobuf::Timestamp]
|
41
43
|
# Reads the version of the document at the given time.
|
@@ -43,6 +45,8 @@ module Google
|
|
43
45
|
# This must be a microsecond precision timestamp within the past one hour,
|
44
46
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
45
47
|
# minute timestamp within the past 7 days.
|
48
|
+
#
|
49
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
46
50
|
class GetDocumentRequest
|
47
51
|
include ::Google::Protobuf::MessageExts
|
48
52
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -97,6 +101,8 @@ module Google
|
|
97
101
|
# @!attribute [rw] transaction
|
98
102
|
# @return [::String]
|
99
103
|
# Perform the read as part of an already active transaction.
|
104
|
+
#
|
105
|
+
# Note: The following fields are mutually exclusive: `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
100
106
|
# @!attribute [rw] read_time
|
101
107
|
# @return [::Google::Protobuf::Timestamp]
|
102
108
|
# Perform the read at the provided time.
|
@@ -104,6 +110,8 @@ module Google
|
|
104
110
|
# This must be a microsecond precision timestamp within the past one hour,
|
105
111
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
106
112
|
# minute timestamp within the past 7 days.
|
113
|
+
#
|
114
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
107
115
|
# @!attribute [rw] show_missing
|
108
116
|
# @return [::Boolean]
|
109
117
|
# If the list should show missing documents.
|
@@ -231,12 +239,16 @@ module Google
|
|
231
239
|
# @!attribute [rw] transaction
|
232
240
|
# @return [::String]
|
233
241
|
# Reads documents in a transaction.
|
242
|
+
#
|
243
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
234
244
|
# @!attribute [rw] new_transaction
|
235
245
|
# @return [::Google::Cloud::Firestore::V1::TransactionOptions]
|
236
246
|
# Starts a new transaction and reads the documents.
|
237
247
|
# Defaults to a read-only transaction.
|
238
248
|
# The new transaction ID will be returned as the first response in the
|
239
249
|
# stream.
|
250
|
+
#
|
251
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
240
252
|
# @!attribute [rw] read_time
|
241
253
|
# @return [::Google::Protobuf::Timestamp]
|
242
254
|
# Reads documents as they were at the given time.
|
@@ -244,6 +256,8 @@ module Google
|
|
244
256
|
# This must be a microsecond precision timestamp within the past one hour,
|
245
257
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
246
258
|
# minute timestamp within the past 7 days.
|
259
|
+
#
|
260
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
247
261
|
class BatchGetDocumentsRequest
|
248
262
|
include ::Google::Protobuf::MessageExts
|
249
263
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -254,10 +268,14 @@ module Google
|
|
254
268
|
# @!attribute [rw] found
|
255
269
|
# @return [::Google::Cloud::Firestore::V1::Document]
|
256
270
|
# A document that was requested.
|
271
|
+
#
|
272
|
+
# Note: The following fields are mutually exclusive: `found`, `missing`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
257
273
|
# @!attribute [rw] missing
|
258
274
|
# @return [::String]
|
259
275
|
# A document name that was requested but does not exist. In the format:
|
260
276
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
277
|
+
#
|
278
|
+
# Note: The following fields are mutually exclusive: `missing`, `found`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
261
279
|
# @!attribute [rw] transaction
|
262
280
|
# @return [::String]
|
263
281
|
# The transaction that was started as part of this request.
|
@@ -364,12 +382,16 @@ module Google
|
|
364
382
|
# Run the query within an already active transaction.
|
365
383
|
#
|
366
384
|
# The value here is the opaque transaction ID to execute the query in.
|
385
|
+
#
|
386
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
367
387
|
# @!attribute [rw] new_transaction
|
368
388
|
# @return [::Google::Cloud::Firestore::V1::TransactionOptions]
|
369
389
|
# Starts a new transaction and reads the documents.
|
370
390
|
# Defaults to a read-only transaction.
|
371
391
|
# The new transaction ID will be returned as the first response in the
|
372
392
|
# stream.
|
393
|
+
#
|
394
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
373
395
|
# @!attribute [rw] read_time
|
374
396
|
# @return [::Google::Protobuf::Timestamp]
|
375
397
|
# Reads documents as they were at the given time.
|
@@ -377,6 +399,8 @@ module Google
|
|
377
399
|
# This must be a microsecond precision timestamp within the past one hour,
|
378
400
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
379
401
|
# minute timestamp within the past 7 days.
|
402
|
+
#
|
403
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
380
404
|
# @!attribute [rw] explain_options
|
381
405
|
# @return [::Google::Cloud::Firestore::V1::ExplainOptions]
|
382
406
|
# Optional. Explain options for the query. If set, additional query
|
@@ -443,12 +467,16 @@ module Google
|
|
443
467
|
# Run the aggregation within an already active transaction.
|
444
468
|
#
|
445
469
|
# The value here is the opaque transaction ID to execute the query in.
|
470
|
+
#
|
471
|
+
# Note: The following fields are mutually exclusive: `transaction`, `new_transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
446
472
|
# @!attribute [rw] new_transaction
|
447
473
|
# @return [::Google::Cloud::Firestore::V1::TransactionOptions]
|
448
474
|
# Starts a new transaction as part of the query, defaulting to read-only.
|
449
475
|
#
|
450
476
|
# The new transaction ID will be returned as the first response in the
|
451
477
|
# stream.
|
478
|
+
#
|
479
|
+
# Note: The following fields are mutually exclusive: `new_transaction`, `transaction`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
452
480
|
# @!attribute [rw] read_time
|
453
481
|
# @return [::Google::Protobuf::Timestamp]
|
454
482
|
# Executes the query at the given timestamp.
|
@@ -456,6 +484,8 @@ module Google
|
|
456
484
|
# This must be a microsecond precision timestamp within the past one hour,
|
457
485
|
# or if Point-in-Time Recovery is enabled, can additionally be a whole
|
458
486
|
# minute timestamp within the past 7 days.
|
487
|
+
#
|
488
|
+
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
459
489
|
# @!attribute [rw] explain_options
|
460
490
|
# @return [::Google::Cloud::Firestore::V1::ExplainOptions]
|
461
491
|
# Optional. Explain options for the query. If set, additional query
|
@@ -684,9 +714,13 @@ module Google
|
|
684
714
|
# @!attribute [rw] add_target
|
685
715
|
# @return [::Google::Cloud::Firestore::V1::Target]
|
686
716
|
# A target to add to this stream.
|
717
|
+
#
|
718
|
+
# Note: The following fields are mutually exclusive: `add_target`, `remove_target`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
687
719
|
# @!attribute [rw] remove_target
|
688
720
|
# @return [::Integer]
|
689
721
|
# The ID of a target to remove from this stream.
|
722
|
+
#
|
723
|
+
# Note: The following fields are mutually exclusive: `remove_target`, `add_target`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
690
724
|
# @!attribute [rw] labels
|
691
725
|
# @return [::Google::Protobuf::Map{::String => ::String}]
|
692
726
|
# Labels associated with this target change.
|
@@ -708,16 +742,24 @@ module Google
|
|
708
742
|
# @!attribute [rw] target_change
|
709
743
|
# @return [::Google::Cloud::Firestore::V1::TargetChange]
|
710
744
|
# Targets have changed.
|
745
|
+
#
|
746
|
+
# Note: The following fields are mutually exclusive: `target_change`, `document_change`, `document_delete`, `document_remove`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
711
747
|
# @!attribute [rw] document_change
|
712
748
|
# @return [::Google::Cloud::Firestore::V1::DocumentChange]
|
713
749
|
# A {::Google::Cloud::Firestore::V1::Document Document} has changed.
|
750
|
+
#
|
751
|
+
# Note: The following fields are mutually exclusive: `document_change`, `target_change`, `document_delete`, `document_remove`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
714
752
|
# @!attribute [rw] document_delete
|
715
753
|
# @return [::Google::Cloud::Firestore::V1::DocumentDelete]
|
716
754
|
# A {::Google::Cloud::Firestore::V1::Document Document} has been deleted.
|
755
|
+
#
|
756
|
+
# Note: The following fields are mutually exclusive: `document_delete`, `target_change`, `document_change`, `document_remove`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
717
757
|
# @!attribute [rw] document_remove
|
718
758
|
# @return [::Google::Cloud::Firestore::V1::DocumentRemove]
|
719
759
|
# A {::Google::Cloud::Firestore::V1::Document Document} has been removed from a target
|
720
760
|
# (because it is no longer relevant to that target).
|
761
|
+
#
|
762
|
+
# Note: The following fields are mutually exclusive: `document_remove`, `target_change`, `document_change`, `document_delete`, `filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
721
763
|
# @!attribute [rw] filter
|
722
764
|
# @return [::Google::Cloud::Firestore::V1::ExistenceFilter]
|
723
765
|
# A filter to apply to the set of documents previously returned for the
|
@@ -725,6 +767,8 @@ module Google
|
|
725
767
|
#
|
726
768
|
# Returned when documents may have been removed from the given target, but
|
727
769
|
# the exact documents are unknown.
|
770
|
+
#
|
771
|
+
# Note: The following fields are mutually exclusive: `filter`, `target_change`, `document_change`, `document_delete`, `document_remove`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
728
772
|
class ListenResponse
|
729
773
|
include ::Google::Protobuf::MessageExts
|
730
774
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -734,20 +778,28 @@ module Google
|
|
734
778
|
# @!attribute [rw] query
|
735
779
|
# @return [::Google::Cloud::Firestore::V1::Target::QueryTarget]
|
736
780
|
# A target specified by a query.
|
781
|
+
#
|
782
|
+
# Note: The following fields are mutually exclusive: `query`, `documents`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
737
783
|
# @!attribute [rw] documents
|
738
784
|
# @return [::Google::Cloud::Firestore::V1::Target::DocumentsTarget]
|
739
785
|
# A target specified by a set of document names.
|
786
|
+
#
|
787
|
+
# Note: The following fields are mutually exclusive: `documents`, `query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
740
788
|
# @!attribute [rw] resume_token
|
741
789
|
# @return [::String]
|
742
790
|
# A resume token from a prior
|
743
791
|
# {::Google::Cloud::Firestore::V1::TargetChange TargetChange} for an identical target.
|
744
792
|
#
|
745
793
|
# Using a resume token with a different target is unsupported and may fail.
|
794
|
+
#
|
795
|
+
# Note: The following fields are mutually exclusive: `resume_token`, `read_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
746
796
|
# @!attribute [rw] read_time
|
747
797
|
# @return [::Google::Protobuf::Timestamp]
|
748
798
|
# Start listening after a specific `read_time`.
|
749
799
|
#
|
750
800
|
# The client must know the state of matching documents at this time.
|
801
|
+
#
|
802
|
+
# Note: The following fields are mutually exclusive: `read_time`, `resume_token`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
751
803
|
# @!attribute [rw] target_id
|
752
804
|
# @return [::Integer]
|
753
805
|
# The target ID that identifies the target on the stream. Must be a positive
|
@@ -158,12 +158,18 @@ module Google
|
|
158
158
|
# @!attribute [rw] composite_filter
|
159
159
|
# @return [::Google::Cloud::Firestore::V1::StructuredQuery::CompositeFilter]
|
160
160
|
# A composite filter.
|
161
|
+
#
|
162
|
+
# Note: The following fields are mutually exclusive: `composite_filter`, `field_filter`, `unary_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
161
163
|
# @!attribute [rw] field_filter
|
162
164
|
# @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldFilter]
|
163
165
|
# A filter on a document field.
|
166
|
+
#
|
167
|
+
# Note: The following fields are mutually exclusive: `field_filter`, `composite_filter`, `unary_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
164
168
|
# @!attribute [rw] unary_filter
|
165
169
|
# @return [::Google::Cloud::Firestore::V1::StructuredQuery::UnaryFilter]
|
166
170
|
# A filter that takes exactly one argument.
|
171
|
+
#
|
172
|
+
# Note: The following fields are mutually exclusive: `unary_filter`, `composite_filter`, `field_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
167
173
|
class Filter
|
168
174
|
include ::Google::Protobuf::MessageExts
|
169
175
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -470,12 +476,18 @@ module Google
|
|
470
476
|
# @!attribute [rw] count
|
471
477
|
# @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count]
|
472
478
|
# Count aggregator.
|
479
|
+
#
|
480
|
+
# Note: The following fields are mutually exclusive: `count`, `sum`, `avg`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
473
481
|
# @!attribute [rw] sum
|
474
482
|
# @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Sum]
|
475
483
|
# Sum aggregator.
|
484
|
+
#
|
485
|
+
# Note: The following fields are mutually exclusive: `sum`, `count`, `avg`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
476
486
|
# @!attribute [rw] avg
|
477
487
|
# @return [::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Avg]
|
478
488
|
# Average aggregator.
|
489
|
+
#
|
490
|
+
# Note: The following fields are mutually exclusive: `avg`, `count`, `sum`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
479
491
|
# @!attribute [rw] alias
|
480
492
|
# @return [::String]
|
481
493
|
# Optional. Optional name of the field to store the result of the
|
@@ -25,13 +25,19 @@ module Google
|
|
25
25
|
# @!attribute [rw] update
|
26
26
|
# @return [::Google::Cloud::Firestore::V1::Document]
|
27
27
|
# A document to write.
|
28
|
+
#
|
29
|
+
# Note: The following fields are mutually exclusive: `update`, `delete`, `transform`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
28
30
|
# @!attribute [rw] delete
|
29
31
|
# @return [::String]
|
30
32
|
# A document name to delete. In the format:
|
31
33
|
# `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
|
34
|
+
#
|
35
|
+
# Note: The following fields are mutually exclusive: `delete`, `update`, `transform`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
32
36
|
# @!attribute [rw] transform
|
33
37
|
# @return [::Google::Cloud::Firestore::V1::DocumentTransform]
|
34
38
|
# Applies a transformation to a document.
|
39
|
+
#
|
40
|
+
# Note: The following fields are mutually exclusive: `transform`, `update`, `delete`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
35
41
|
# @!attribute [rw] update_mask
|
36
42
|
# @return [::Google::Cloud::Firestore::V1::DocumentMask]
|
37
43
|
# The fields to update in this write.
|
@@ -83,6 +89,8 @@ module Google
|
|
83
89
|
# @!attribute [rw] set_to_server_value
|
84
90
|
# @return [::Google::Cloud::Firestore::V1::DocumentTransform::FieldTransform::ServerValue]
|
85
91
|
# Sets the field to the given server value.
|
92
|
+
#
|
93
|
+
# Note: The following fields are mutually exclusive: `set_to_server_value`, `increment`, `maximum`, `minimum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
86
94
|
# @!attribute [rw] increment
|
87
95
|
# @return [::Google::Cloud::Firestore::V1::Value]
|
88
96
|
# Adds the given value to the field's current value.
|
@@ -95,6 +103,8 @@ module Google
|
|
95
103
|
# representation of double values follow IEEE 754 semantics.
|
96
104
|
# If there is positive/negative integer overflow, the field is resolved
|
97
105
|
# to the largest magnitude positive/negative integer.
|
106
|
+
#
|
107
|
+
# Note: The following fields are mutually exclusive: `increment`, `set_to_server_value`, `maximum`, `minimum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
98
108
|
# @!attribute [rw] maximum
|
99
109
|
# @return [::Google::Cloud::Firestore::V1::Value]
|
100
110
|
# Sets the field to the maximum of its current value and the given value.
|
@@ -109,6 +119,8 @@ module Google
|
|
109
119
|
# 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and
|
110
120
|
# zero input value is always the stored value.
|
111
121
|
# The maximum of any numeric value x and NaN is NaN.
|
122
|
+
#
|
123
|
+
# Note: The following fields are mutually exclusive: `maximum`, `set_to_server_value`, `increment`, `minimum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
112
124
|
# @!attribute [rw] minimum
|
113
125
|
# @return [::Google::Cloud::Firestore::V1::Value]
|
114
126
|
# Sets the field to the minimum of its current value and the given value.
|
@@ -123,6 +135,8 @@ module Google
|
|
123
135
|
# 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and
|
124
136
|
# zero input value is always the stored value.
|
125
137
|
# The minimum of any numeric value x and NaN is NaN.
|
138
|
+
#
|
139
|
+
# Note: The following fields are mutually exclusive: `minimum`, `set_to_server_value`, `increment`, `maximum`, `append_missing_elements`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
126
140
|
# @!attribute [rw] append_missing_elements
|
127
141
|
# @return [::Google::Cloud::Firestore::V1::ArrayValue]
|
128
142
|
# Append the given elements in order if they are not already present in
|
@@ -137,6 +151,8 @@ module Google
|
|
137
151
|
# be considered.
|
138
152
|
#
|
139
153
|
# The corresponding transform_result will be the null value.
|
154
|
+
#
|
155
|
+
# Note: The following fields are mutually exclusive: `append_missing_elements`, `set_to_server_value`, `increment`, `maximum`, `minimum`, `remove_all_from_array`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
140
156
|
# @!attribute [rw] remove_all_from_array
|
141
157
|
# @return [::Google::Cloud::Firestore::V1::ArrayValue]
|
142
158
|
# Remove all of the given elements from the array in the field.
|
@@ -149,6 +165,8 @@ module Google
|
|
149
165
|
# This will remove all equivalent values if there are duplicates.
|
150
166
|
#
|
151
167
|
# The corresponding transform_result will be the null value.
|
168
|
+
#
|
169
|
+
# Note: The following fields are mutually exclusive: `remove_all_from_array`, `set_to_server_value`, `increment`, `maximum`, `minimum`, `append_missing_elements`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
152
170
|
class FieldTransform
|
153
171
|
include ::Google::Protobuf::MessageExts
|
154
172
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -53,21 +53,33 @@ module Google
|
|
53
53
|
# @!attribute [rw] null_value
|
54
54
|
# @return [::Google::Protobuf::NullValue]
|
55
55
|
# Represents a null value.
|
56
|
+
#
|
57
|
+
# Note: The following fields are mutually exclusive: `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
56
58
|
# @!attribute [rw] number_value
|
57
59
|
# @return [::Float]
|
58
60
|
# Represents a double value.
|
61
|
+
#
|
62
|
+
# Note: The following fields are mutually exclusive: `number_value`, `null_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
59
63
|
# @!attribute [rw] string_value
|
60
64
|
# @return [::String]
|
61
65
|
# Represents a string value.
|
66
|
+
#
|
67
|
+
# Note: The following fields are mutually exclusive: `string_value`, `null_value`, `number_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
62
68
|
# @!attribute [rw] bool_value
|
63
69
|
# @return [::Boolean]
|
64
70
|
# Represents a boolean value.
|
71
|
+
#
|
72
|
+
# Note: The following fields are mutually exclusive: `bool_value`, `null_value`, `number_value`, `string_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
65
73
|
# @!attribute [rw] struct_value
|
66
74
|
# @return [::Google::Protobuf::Struct]
|
67
75
|
# Represents a structured value.
|
76
|
+
#
|
77
|
+
# Note: The following fields are mutually exclusive: `struct_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
68
78
|
# @!attribute [rw] list_value
|
69
79
|
# @return [::Google::Protobuf::ListValue]
|
70
80
|
# Represents a repeated `Value`.
|
81
|
+
#
|
82
|
+
# Note: The following fields are mutually exclusive: `list_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
71
83
|
class Value
|
72
84
|
include ::Google::Protobuf::MessageExts
|
73
85
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
@@ -1,14 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-firestore-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 2.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
|
-
autorequire:
|
9
8
|
bindir: bin
|
10
9
|
cert_chain: []
|
11
|
-
date:
|
10
|
+
date: 2025-02-07 00:00:00.000000000 Z
|
12
11
|
dependencies:
|
13
12
|
- !ruby/object:Gem::Dependency
|
14
13
|
name: gapic-common
|
@@ -16,7 +15,7 @@ dependencies:
|
|
16
15
|
requirements:
|
17
16
|
- - ">="
|
18
17
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
18
|
+
version: 0.25.0
|
20
19
|
- - "<"
|
21
20
|
- !ruby/object:Gem::Version
|
22
21
|
version: 2.a
|
@@ -26,7 +25,7 @@ dependencies:
|
|
26
25
|
requirements:
|
27
26
|
- - ">="
|
28
27
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
28
|
+
version: 0.25.0
|
30
29
|
- - "<"
|
31
30
|
- !ruby/object:Gem::Version
|
32
31
|
version: 2.a
|
@@ -121,7 +120,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
|
|
121
120
|
licenses:
|
122
121
|
- Apache-2.0
|
123
122
|
metadata: {}
|
124
|
-
post_install_message:
|
125
123
|
rdoc_options: []
|
126
124
|
require_paths:
|
127
125
|
- lib
|
@@ -129,15 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
129
127
|
requirements:
|
130
128
|
- - ">="
|
131
129
|
- !ruby/object:Gem::Version
|
132
|
-
version: '
|
130
|
+
version: '3.0'
|
133
131
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
134
132
|
requirements:
|
135
133
|
- - ">="
|
136
134
|
- !ruby/object:Gem::Version
|
137
135
|
version: '0'
|
138
136
|
requirements: []
|
139
|
-
rubygems_version: 3.
|
140
|
-
signing_key:
|
137
|
+
rubygems_version: 3.6.3
|
141
138
|
specification_version: 4
|
142
139
|
summary: Accesses the NoSQL document database built for automatic scaling, high performance,
|
143
140
|
and ease of application development.
|