google-apis-firestore_v1beta1 0.52.0 → 0.53.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
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cf3c5d5330784ec32b02f0b5d666d3aad84c8f3fb0138b590c7164e64075750a
|
|
4
|
+
data.tar.gz: eac82dd19924fe709e87d4e45823346209951cef0800edae99886a4e2219e323
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 37c59f9caf110c3edd1c78dd4dcd62ae243a31cd144832928213eb18b7b059070382ffe8c6154353ebcb27b57647392c07b4b5c105a98c49de920e23fa566bf9
|
|
7
|
+
data.tar.gz: de2519c44f54dae52426cd4dbdf7c2235e2b9e5ec3360d0435e34b541b4d4158391bb416bcc85e142e3024867013d89eb9326286570305ddba0a39b36ad752a2
|
data/CHANGELOG.md
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
# Release history for google-apis-firestore_v1beta1
|
|
2
2
|
|
|
3
|
-
### v0.
|
|
3
|
+
### v0.53.0 (2026-07-12)
|
|
4
4
|
|
|
5
|
+
* Regenerated from discovery document revision 20260702
|
|
6
|
+
|
|
7
|
+
### v0.52.0 (2026-06-21)
|
|
8
|
+
|
|
9
|
+
* Regenerated from discovery document revision 20260608
|
|
5
10
|
* Regenerated using generator version 0.19.0
|
|
6
11
|
|
|
7
12
|
### v0.51.0 (2026-05-10)
|
|
@@ -180,6 +180,11 @@ module Google
|
|
|
180
180
|
# @return [String]
|
|
181
181
|
attr_accessor :read_time
|
|
182
182
|
|
|
183
|
+
# Options for a server request.
|
|
184
|
+
# Corresponds to the JSON property `requestOptions`
|
|
185
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
186
|
+
attr_accessor :request_options
|
|
187
|
+
|
|
183
188
|
# Reads documents in a transaction.
|
|
184
189
|
# Corresponds to the JSON property `transaction`
|
|
185
190
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
@@ -196,6 +201,7 @@ module Google
|
|
|
196
201
|
@mask = args[:mask] if args.key?(:mask)
|
|
197
202
|
@new_transaction = args[:new_transaction] if args.key?(:new_transaction)
|
|
198
203
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
204
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
199
205
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
200
206
|
end
|
|
201
207
|
end
|
|
@@ -252,6 +258,11 @@ module Google
|
|
|
252
258
|
# @return [Hash<String,String>]
|
|
253
259
|
attr_accessor :labels
|
|
254
260
|
|
|
261
|
+
# Options for a server request.
|
|
262
|
+
# Corresponds to the JSON property `requestOptions`
|
|
263
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
264
|
+
attr_accessor :request_options
|
|
265
|
+
|
|
255
266
|
# The writes to apply. Method does not apply writes atomically and does not
|
|
256
267
|
# guarantee ordering. Each write succeeds or fails independently. You cannot
|
|
257
268
|
# write to the same document more than once per request.
|
|
@@ -266,6 +277,7 @@ module Google
|
|
|
266
277
|
# Update properties of this object
|
|
267
278
|
def update!(**args)
|
|
268
279
|
@labels = args[:labels] if args.key?(:labels)
|
|
280
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
269
281
|
@writes = args[:writes] if args.key?(:writes)
|
|
270
282
|
end
|
|
271
283
|
end
|
|
@@ -306,6 +318,11 @@ module Google
|
|
|
306
318
|
# @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
|
|
307
319
|
attr_accessor :options
|
|
308
320
|
|
|
321
|
+
# Options for a server request.
|
|
322
|
+
# Corresponds to the JSON property `requestOptions`
|
|
323
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
324
|
+
attr_accessor :request_options
|
|
325
|
+
|
|
309
326
|
def initialize(**args)
|
|
310
327
|
update!(**args)
|
|
311
328
|
end
|
|
@@ -313,6 +330,7 @@ module Google
|
|
|
313
330
|
# Update properties of this object
|
|
314
331
|
def update!(**args)
|
|
315
332
|
@options = args[:options] if args.key?(:options)
|
|
333
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
316
334
|
end
|
|
317
335
|
end
|
|
318
336
|
|
|
@@ -450,6 +468,11 @@ module Google
|
|
|
450
468
|
class CommitRequest
|
|
451
469
|
include Google::Apis::Core::Hashable
|
|
452
470
|
|
|
471
|
+
# Options for a server request.
|
|
472
|
+
# Corresponds to the JSON property `requestOptions`
|
|
473
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
474
|
+
attr_accessor :request_options
|
|
475
|
+
|
|
453
476
|
# If set, applies all writes in this transaction, and commits it.
|
|
454
477
|
# Corresponds to the JSON property `transaction`
|
|
455
478
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
@@ -467,6 +490,7 @@ module Google
|
|
|
467
490
|
|
|
468
491
|
# Update properties of this object
|
|
469
492
|
def update!(**args)
|
|
493
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
470
494
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
471
495
|
@writes = args[:writes] if args.key?(:writes)
|
|
472
496
|
end
|
|
@@ -830,6 +854,14 @@ module Google
|
|
|
830
854
|
class ExecutePipelineRequest
|
|
831
855
|
include Google::Apis::Core::Hashable
|
|
832
856
|
|
|
857
|
+
# Optional. Automatically commits the transaction after the pipeline has been
|
|
858
|
+
# executed. Only permitted in combination with `transaction` or `new_transaction`
|
|
859
|
+
# .
|
|
860
|
+
# Corresponds to the JSON property `autoCommitTransaction`
|
|
861
|
+
# @return [Boolean]
|
|
862
|
+
attr_accessor :auto_commit_transaction
|
|
863
|
+
alias_method :auto_commit_transaction?, :auto_commit_transaction
|
|
864
|
+
|
|
833
865
|
# Options for creating a new transaction.
|
|
834
866
|
# Corresponds to the JSON property `newTransaction`
|
|
835
867
|
# @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
|
|
@@ -843,6 +875,11 @@ module Google
|
|
|
843
875
|
# @return [String]
|
|
844
876
|
attr_accessor :read_time
|
|
845
877
|
|
|
878
|
+
# Options for a server request.
|
|
879
|
+
# Corresponds to the JSON property `requestOptions`
|
|
880
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
881
|
+
attr_accessor :request_options
|
|
882
|
+
|
|
846
883
|
# A Firestore query represented as an ordered list of operations / stages. This
|
|
847
884
|
# is considered the top-level function which plans and executes a query. It is
|
|
848
885
|
# logically equivalent to `query(stages, options)`, but prevents the client from
|
|
@@ -864,8 +901,10 @@ module Google
|
|
|
864
901
|
|
|
865
902
|
# Update properties of this object
|
|
866
903
|
def update!(**args)
|
|
904
|
+
@auto_commit_transaction = args[:auto_commit_transaction] if args.key?(:auto_commit_transaction)
|
|
867
905
|
@new_transaction = args[:new_transaction] if args.key?(:new_transaction)
|
|
868
906
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
907
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
869
908
|
@structured_pipeline = args[:structured_pipeline] if args.key?(:structured_pipeline)
|
|
870
909
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
871
910
|
end
|
|
@@ -2071,6 +2110,11 @@ module Google
|
|
|
2071
2110
|
# @return [String]
|
|
2072
2111
|
attr_accessor :read_time
|
|
2073
2112
|
|
|
2113
|
+
# Options for a server request.
|
|
2114
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2115
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2116
|
+
attr_accessor :request_options
|
|
2117
|
+
|
|
2074
2118
|
def initialize(**args)
|
|
2075
2119
|
update!(**args)
|
|
2076
2120
|
end
|
|
@@ -2080,6 +2124,7 @@ module Google
|
|
|
2080
2124
|
@page_size = args[:page_size] if args.key?(:page_size)
|
|
2081
2125
|
@page_token = args[:page_token] if args.key?(:page_token)
|
|
2082
2126
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2127
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2083
2128
|
end
|
|
2084
2129
|
end
|
|
2085
2130
|
|
|
@@ -2153,6 +2198,11 @@ module Google
|
|
|
2153
2198
|
# @return [Fixnum]
|
|
2154
2199
|
attr_accessor :remove_target
|
|
2155
2200
|
|
|
2201
|
+
# Options for a server request.
|
|
2202
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2203
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2204
|
+
attr_accessor :request_options
|
|
2205
|
+
|
|
2156
2206
|
def initialize(**args)
|
|
2157
2207
|
update!(**args)
|
|
2158
2208
|
end
|
|
@@ -2162,6 +2212,7 @@ module Google
|
|
|
2162
2212
|
@add_target = args[:add_target] if args.key?(:add_target)
|
|
2163
2213
|
@labels = args[:labels] if args.key?(:labels)
|
|
2164
2214
|
@remove_target = args[:remove_target] if args.key?(:remove_target)
|
|
2215
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2165
2216
|
end
|
|
2166
2217
|
end
|
|
2167
2218
|
|
|
@@ -2308,6 +2359,11 @@ module Google
|
|
|
2308
2359
|
# @return [String]
|
|
2309
2360
|
attr_accessor :read_time
|
|
2310
2361
|
|
|
2362
|
+
# Options for a server request.
|
|
2363
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2364
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2365
|
+
attr_accessor :request_options
|
|
2366
|
+
|
|
2311
2367
|
# A Firestore query. The query stages are executed in the following order: 1.
|
|
2312
2368
|
# from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
|
|
2313
2369
|
# find_nearest
|
|
@@ -2325,6 +2381,7 @@ module Google
|
|
|
2325
2381
|
@page_token = args[:page_token] if args.key?(:page_token)
|
|
2326
2382
|
@partition_count = args[:partition_count] if args.key?(:partition_count)
|
|
2327
2383
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2384
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2328
2385
|
@structured_query = args[:structured_query] if args.key?(:structured_query)
|
|
2329
2386
|
end
|
|
2330
2387
|
end
|
|
@@ -2535,10 +2592,34 @@ module Google
|
|
|
2535
2592
|
end
|
|
2536
2593
|
end
|
|
2537
2594
|
|
|
2595
|
+
# Options for a server request.
|
|
2596
|
+
class RequestOptions
|
|
2597
|
+
include Google::Apis::Core::Hashable
|
|
2598
|
+
|
|
2599
|
+
# Optional. The request tags for the request.
|
|
2600
|
+
# Corresponds to the JSON property `requestTags`
|
|
2601
|
+
# @return [Array<String>]
|
|
2602
|
+
attr_accessor :request_tags
|
|
2603
|
+
|
|
2604
|
+
def initialize(**args)
|
|
2605
|
+
update!(**args)
|
|
2606
|
+
end
|
|
2607
|
+
|
|
2608
|
+
# Update properties of this object
|
|
2609
|
+
def update!(**args)
|
|
2610
|
+
@request_tags = args[:request_tags] if args.key?(:request_tags)
|
|
2611
|
+
end
|
|
2612
|
+
end
|
|
2613
|
+
|
|
2538
2614
|
# The request for Firestore.Rollback.
|
|
2539
2615
|
class RollbackRequest
|
|
2540
2616
|
include Google::Apis::Core::Hashable
|
|
2541
2617
|
|
|
2618
|
+
# Options for a server request.
|
|
2619
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2620
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2621
|
+
attr_accessor :request_options
|
|
2622
|
+
|
|
2542
2623
|
# Required. The transaction to roll back.
|
|
2543
2624
|
# Corresponds to the JSON property `transaction`
|
|
2544
2625
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
@@ -2551,6 +2632,7 @@ module Google
|
|
|
2551
2632
|
|
|
2552
2633
|
# Update properties of this object
|
|
2553
2634
|
def update!(**args)
|
|
2635
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2554
2636
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
2555
2637
|
end
|
|
2556
2638
|
end
|
|
@@ -2576,6 +2658,11 @@ module Google
|
|
|
2576
2658
|
# @return [String]
|
|
2577
2659
|
attr_accessor :read_time
|
|
2578
2660
|
|
|
2661
|
+
# Options for a server request.
|
|
2662
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2663
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2664
|
+
attr_accessor :request_options
|
|
2665
|
+
|
|
2579
2666
|
# Firestore query for running an aggregation over a StructuredQuery.
|
|
2580
2667
|
# Corresponds to the JSON property `structuredAggregationQuery`
|
|
2581
2668
|
# @return [Google::Apis::FirestoreV1beta1::StructuredAggregationQuery]
|
|
@@ -2597,6 +2684,7 @@ module Google
|
|
|
2597
2684
|
@explain_options = args[:explain_options] if args.key?(:explain_options)
|
|
2598
2685
|
@new_transaction = args[:new_transaction] if args.key?(:new_transaction)
|
|
2599
2686
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2687
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2600
2688
|
@structured_aggregation_query = args[:structured_aggregation_query] if args.key?(:structured_aggregation_query)
|
|
2601
2689
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
2602
2690
|
end
|
|
@@ -2668,6 +2756,11 @@ module Google
|
|
|
2668
2756
|
# @return [String]
|
|
2669
2757
|
attr_accessor :read_time
|
|
2670
2758
|
|
|
2759
|
+
# Options for a server request.
|
|
2760
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2761
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2762
|
+
attr_accessor :request_options
|
|
2763
|
+
|
|
2671
2764
|
# A Firestore query. The query stages are executed in the following order: 1.
|
|
2672
2765
|
# from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
|
|
2673
2766
|
# find_nearest
|
|
@@ -2691,6 +2784,7 @@ module Google
|
|
|
2691
2784
|
@explain_options = args[:explain_options] if args.key?(:explain_options)
|
|
2692
2785
|
@new_transaction = args[:new_transaction] if args.key?(:new_transaction)
|
|
2693
2786
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2787
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2694
2788
|
@structured_query = args[:structured_query] if args.key?(:structured_query)
|
|
2695
2789
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
2696
2790
|
end
|
|
@@ -3382,6 +3476,11 @@ module Google
|
|
|
3382
3476
|
# @return [Hash<String,String>]
|
|
3383
3477
|
attr_accessor :labels
|
|
3384
3478
|
|
|
3479
|
+
# Options for a server request.
|
|
3480
|
+
# Corresponds to the JSON property `requestOptions`
|
|
3481
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
3482
|
+
attr_accessor :request_options
|
|
3483
|
+
|
|
3385
3484
|
# The ID of the write stream to resume. This may only be set in the first
|
|
3386
3485
|
# message. When left empty, a new write stream will be created.
|
|
3387
3486
|
# Corresponds to the JSON property `streamId`
|
|
@@ -3415,6 +3514,7 @@ module Google
|
|
|
3415
3514
|
# Update properties of this object
|
|
3416
3515
|
def update!(**args)
|
|
3417
3516
|
@labels = args[:labels] if args.key?(:labels)
|
|
3517
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
3418
3518
|
@stream_id = args[:stream_id] if args.key?(:stream_id)
|
|
3419
3519
|
@stream_token = args[:stream_token] if args.key?(:stream_token)
|
|
3420
3520
|
@writes = args[:writes] if args.key?(:writes)
|
|
@@ -16,13 +16,13 @@ module Google
|
|
|
16
16
|
module Apis
|
|
17
17
|
module FirestoreV1beta1
|
|
18
18
|
# Version of the google-apis-firestore_v1beta1 gem
|
|
19
|
-
GEM_VERSION = "0.
|
|
19
|
+
GEM_VERSION = "0.53.0"
|
|
20
20
|
|
|
21
21
|
# Version of the code generator used to generate this client
|
|
22
22
|
GENERATOR_VERSION = "0.19.0"
|
|
23
23
|
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
|
25
|
-
REVISION = "
|
|
25
|
+
REVISION = "20260702"
|
|
26
26
|
end
|
|
27
27
|
end
|
|
28
28
|
end
|
|
@@ -478,6 +478,12 @@ module Google
|
|
|
478
478
|
include Google::Apis::Core::JsonObjectSupport
|
|
479
479
|
end
|
|
480
480
|
|
|
481
|
+
class RequestOptions
|
|
482
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
483
|
+
|
|
484
|
+
include Google::Apis::Core::JsonObjectSupport
|
|
485
|
+
end
|
|
486
|
+
|
|
481
487
|
class RollbackRequest
|
|
482
488
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
|
483
489
|
|
|
@@ -644,6 +650,8 @@ module Google
|
|
|
644
650
|
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
645
651
|
|
|
646
652
|
property :read_time, as: 'readTime'
|
|
653
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
654
|
+
|
|
647
655
|
property :transaction, :base64 => true, as: 'transaction'
|
|
648
656
|
end
|
|
649
657
|
end
|
|
@@ -663,6 +671,8 @@ module Google
|
|
|
663
671
|
# @private
|
|
664
672
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
665
673
|
hash :labels, as: 'labels'
|
|
674
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
675
|
+
|
|
666
676
|
collection :writes, as: 'writes', class: Google::Apis::FirestoreV1beta1::Write, decorator: Google::Apis::FirestoreV1beta1::Write::Representation
|
|
667
677
|
|
|
668
678
|
end
|
|
@@ -683,6 +693,8 @@ module Google
|
|
|
683
693
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
684
694
|
property :options, as: 'options', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
685
695
|
|
|
696
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
697
|
+
|
|
686
698
|
end
|
|
687
699
|
end
|
|
688
700
|
|
|
@@ -721,6 +733,8 @@ module Google
|
|
|
721
733
|
class CommitRequest
|
|
722
734
|
# @private
|
|
723
735
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
736
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
737
|
+
|
|
724
738
|
property :transaction, :base64 => true, as: 'transaction'
|
|
725
739
|
collection :writes, as: 'writes', class: Google::Apis::FirestoreV1beta1::Write, decorator: Google::Apis::FirestoreV1beta1::Write::Representation
|
|
726
740
|
|
|
@@ -832,9 +846,12 @@ module Google
|
|
|
832
846
|
class ExecutePipelineRequest
|
|
833
847
|
# @private
|
|
834
848
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
849
|
+
property :auto_commit_transaction, as: 'autoCommitTransaction'
|
|
835
850
|
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
836
851
|
|
|
837
852
|
property :read_time, as: 'readTime'
|
|
853
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
854
|
+
|
|
838
855
|
property :structured_pipeline, as: 'structuredPipeline', class: Google::Apis::FirestoreV1beta1::StructuredPipeline, decorator: Google::Apis::FirestoreV1beta1::StructuredPipeline::Representation
|
|
839
856
|
|
|
840
857
|
property :transaction, :base64 => true, as: 'transaction'
|
|
@@ -1182,6 +1199,8 @@ module Google
|
|
|
1182
1199
|
property :page_size, as: 'pageSize'
|
|
1183
1200
|
property :page_token, as: 'pageToken'
|
|
1184
1201
|
property :read_time, as: 'readTime'
|
|
1202
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1203
|
+
|
|
1185
1204
|
end
|
|
1186
1205
|
end
|
|
1187
1206
|
|
|
@@ -1209,6 +1228,8 @@ module Google
|
|
|
1209
1228
|
|
|
1210
1229
|
hash :labels, as: 'labels'
|
|
1211
1230
|
property :remove_target, as: 'removeTarget'
|
|
1231
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1232
|
+
|
|
1212
1233
|
end
|
|
1213
1234
|
end
|
|
1214
1235
|
|
|
@@ -1252,6 +1273,8 @@ module Google
|
|
|
1252
1273
|
property :page_token, as: 'pageToken'
|
|
1253
1274
|
property :partition_count, :numeric_string => true, as: 'partitionCount'
|
|
1254
1275
|
property :read_time, as: 'readTime'
|
|
1276
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1277
|
+
|
|
1255
1278
|
property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
|
|
1256
1279
|
|
|
1257
1280
|
end
|
|
@@ -1321,9 +1344,18 @@ module Google
|
|
|
1321
1344
|
end
|
|
1322
1345
|
end
|
|
1323
1346
|
|
|
1347
|
+
class RequestOptions
|
|
1348
|
+
# @private
|
|
1349
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1350
|
+
collection :request_tags, as: 'requestTags'
|
|
1351
|
+
end
|
|
1352
|
+
end
|
|
1353
|
+
|
|
1324
1354
|
class RollbackRequest
|
|
1325
1355
|
# @private
|
|
1326
1356
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1357
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1358
|
+
|
|
1327
1359
|
property :transaction, :base64 => true, as: 'transaction'
|
|
1328
1360
|
end
|
|
1329
1361
|
end
|
|
@@ -1336,6 +1368,8 @@ module Google
|
|
|
1336
1368
|
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
1337
1369
|
|
|
1338
1370
|
property :read_time, as: 'readTime'
|
|
1371
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1372
|
+
|
|
1339
1373
|
property :structured_aggregation_query, as: 'structuredAggregationQuery', class: Google::Apis::FirestoreV1beta1::StructuredAggregationQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredAggregationQuery::Representation
|
|
1340
1374
|
|
|
1341
1375
|
property :transaction, :base64 => true, as: 'transaction'
|
|
@@ -1362,6 +1396,8 @@ module Google
|
|
|
1362
1396
|
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
1363
1397
|
|
|
1364
1398
|
property :read_time, as: 'readTime'
|
|
1399
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1400
|
+
|
|
1365
1401
|
property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
|
|
1366
1402
|
|
|
1367
1403
|
property :transaction, :base64 => true, as: 'transaction'
|
|
@@ -1545,6 +1581,8 @@ module Google
|
|
|
1545
1581
|
# @private
|
|
1546
1582
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1547
1583
|
hash :labels, as: 'labels'
|
|
1584
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1585
|
+
|
|
1548
1586
|
property :stream_id, as: 'streamId'
|
|
1549
1587
|
property :stream_token, :base64 => true, as: 'streamToken'
|
|
1550
1588
|
collection :writes, as: 'writes', class: Google::Apis::FirestoreV1beta1::Write, decorator: Google::Apis::FirestoreV1beta1::Write::Representation
|
|
@@ -286,6 +286,8 @@ module Google
|
|
|
286
286
|
# @param [Array<String>, String] mask_field_paths
|
|
287
287
|
# The list of field paths in the mask. See Document.fields for a field path
|
|
288
288
|
# syntax reference.
|
|
289
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
290
|
+
# Optional. The request tags for the request.
|
|
289
291
|
# @param [String] fields
|
|
290
292
|
# Selector specifying which fields to include in a partial response.
|
|
291
293
|
# @param [String] quota_user
|
|
@@ -303,7 +305,7 @@ module Google
|
|
|
303
305
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
304
306
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
305
307
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
306
|
-
def create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
308
|
+
def create_project_database_document_document(parent, collection_id, document_object = nil, document_id: nil, mask_field_paths: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
307
309
|
command = make_simple_command(:post, 'v1beta1/{+parent}/{collectionId}', options)
|
|
308
310
|
command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
|
309
311
|
command.request_object = document_object
|
|
@@ -313,6 +315,7 @@ module Google
|
|
|
313
315
|
command.params['collectionId'] = collection_id unless collection_id.nil?
|
|
314
316
|
command.query['documentId'] = document_id unless document_id.nil?
|
|
315
317
|
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
|
318
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
316
319
|
command.query['fields'] = fields unless fields.nil?
|
|
317
320
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
318
321
|
execute_or_queue_command(command, &block)
|
|
@@ -328,6 +331,8 @@ module Google
|
|
|
328
331
|
# @param [String] current_document_update_time
|
|
329
332
|
# When set, the target document must exist and have been last updated at that
|
|
330
333
|
# time. Timestamp must be microsecond aligned.
|
|
334
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
335
|
+
# Optional. The request tags for the request.
|
|
331
336
|
# @param [String] fields
|
|
332
337
|
# Selector specifying which fields to include in a partial response.
|
|
333
338
|
# @param [String] quota_user
|
|
@@ -345,13 +350,14 @@ module Google
|
|
|
345
350
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
346
351
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
347
352
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
348
|
-
def delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
353
|
+
def delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, request_options_request_tags: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
349
354
|
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
|
350
355
|
command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
|
|
351
356
|
command.response_class = Google::Apis::FirestoreV1beta1::Empty
|
|
352
357
|
command.params['name'] = name unless name.nil?
|
|
353
358
|
command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
|
|
354
359
|
command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
|
|
360
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
355
361
|
command.query['fields'] = fields unless fields.nil?
|
|
356
362
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
357
363
|
execute_or_queue_command(command, &block)
|
|
@@ -403,6 +409,8 @@ module Google
|
|
|
403
409
|
# microsecond precision timestamp within the past one hour, or if Point-in-Time
|
|
404
410
|
# Recovery is enabled, can additionally be a whole minute timestamp within the
|
|
405
411
|
# past 7 days.
|
|
412
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
413
|
+
# Optional. The request tags for the request.
|
|
406
414
|
# @param [String] transaction
|
|
407
415
|
# Reads the document in a transaction.
|
|
408
416
|
# @param [String] fields
|
|
@@ -422,13 +430,14 @@ module Google
|
|
|
422
430
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
423
431
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
424
432
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
425
|
-
def get_project_database_document(name, mask_field_paths: nil, read_time: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
433
|
+
def get_project_database_document(name, mask_field_paths: nil, read_time: nil, request_options_request_tags: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
426
434
|
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
427
435
|
command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
|
428
436
|
command.response_class = Google::Apis::FirestoreV1beta1::Document
|
|
429
437
|
command.params['name'] = name unless name.nil?
|
|
430
438
|
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
|
431
439
|
command.query['readTime'] = read_time unless read_time.nil?
|
|
440
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
432
441
|
command.query['transaction'] = transaction unless transaction.nil?
|
|
433
442
|
command.query['fields'] = fields unless fields.nil?
|
|
434
443
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
@@ -466,6 +475,15 @@ module Google
|
|
|
466
475
|
# Perform the read at the provided time. This must be a microsecond precision
|
|
467
476
|
# timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
|
|
468
477
|
# can additionally be a whole minute timestamp within the past 7 days.
|
|
478
|
+
# @param [Boolean] recursive
|
|
479
|
+
# Optional. If the list should recursively include all documents nested under
|
|
480
|
+
# the parent at any level. If the request specifies a `collection_id`, then the
|
|
481
|
+
# list will include all nested documents in the collection under the parent.
|
|
482
|
+
# This is optional, and when not provided, Firestore will only list documents
|
|
483
|
+
# nested immediately under the parent. Requests with `recursive` may not specify
|
|
484
|
+
# `show_missing`.
|
|
485
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
486
|
+
# Optional. The request tags for the request.
|
|
469
487
|
# @param [Boolean] show_missing
|
|
470
488
|
# If the list should show missing documents. A document is missing if it does
|
|
471
489
|
# not exist, but there are sub-documents nested underneath it. When true, such
|
|
@@ -491,7 +509,7 @@ module Google
|
|
|
491
509
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
492
510
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
493
511
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
494
|
-
def list_project_database_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
512
|
+
def list_project_database_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
495
513
|
command = make_simple_command(:get, 'v1beta1/{+parent}/{collectionId}', options)
|
|
496
514
|
command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
|
|
497
515
|
command.response_class = Google::Apis::FirestoreV1beta1::ListDocumentsResponse
|
|
@@ -502,6 +520,8 @@ module Google
|
|
|
502
520
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
503
521
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
504
522
|
command.query['readTime'] = read_time unless read_time.nil?
|
|
523
|
+
command.query['recursive'] = recursive unless recursive.nil?
|
|
524
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
505
525
|
command.query['showMissing'] = show_missing unless show_missing.nil?
|
|
506
526
|
command.query['transaction'] = transaction unless transaction.nil?
|
|
507
527
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -576,6 +596,15 @@ module Google
|
|
|
576
596
|
# Perform the read at the provided time. This must be a microsecond precision
|
|
577
597
|
# timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
|
|
578
598
|
# can additionally be a whole minute timestamp within the past 7 days.
|
|
599
|
+
# @param [Boolean] recursive
|
|
600
|
+
# Optional. If the list should recursively include all documents nested under
|
|
601
|
+
# the parent at any level. If the request specifies a `collection_id`, then the
|
|
602
|
+
# list will include all nested documents in the collection under the parent.
|
|
603
|
+
# This is optional, and when not provided, Firestore will only list documents
|
|
604
|
+
# nested immediately under the parent. Requests with `recursive` may not specify
|
|
605
|
+
# `show_missing`.
|
|
606
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
607
|
+
# Optional. The request tags for the request.
|
|
579
608
|
# @param [Boolean] show_missing
|
|
580
609
|
# If the list should show missing documents. A document is missing if it does
|
|
581
610
|
# not exist, but there are sub-documents nested underneath it. When true, such
|
|
@@ -601,7 +630,7 @@ module Google
|
|
|
601
630
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
602
631
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
603
632
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
604
|
-
def list_project_database_document_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
633
|
+
def list_project_database_document_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, recursive: nil, request_options_request_tags: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
605
634
|
command = make_simple_command(:get, 'v1beta1/{+parent}/{collectionId}', options)
|
|
606
635
|
command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
|
|
607
636
|
command.response_class = Google::Apis::FirestoreV1beta1::ListDocumentsResponse
|
|
@@ -612,6 +641,8 @@ module Google
|
|
|
612
641
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
613
642
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
614
643
|
command.query['readTime'] = read_time unless read_time.nil?
|
|
644
|
+
command.query['recursive'] = recursive unless recursive.nil?
|
|
645
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
615
646
|
command.query['showMissing'] = show_missing unless show_missing.nil?
|
|
616
647
|
command.query['transaction'] = transaction unless transaction.nil?
|
|
617
648
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -705,6 +736,8 @@ module Google
|
|
|
705
736
|
# @param [Array<String>, String] mask_field_paths
|
|
706
737
|
# The list of field paths in the mask. See Document.fields for a field path
|
|
707
738
|
# syntax reference.
|
|
739
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
740
|
+
# Optional. The request tags for the request.
|
|
708
741
|
# @param [Array<String>, String] update_mask_field_paths
|
|
709
742
|
# The list of field paths in the mask. See Document.fields for a field path
|
|
710
743
|
# syntax reference.
|
|
@@ -725,7 +758,7 @@ module Google
|
|
|
725
758
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
726
759
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
727
760
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
728
|
-
def patch_project_database_document(name, document_object = nil, current_document_exists: nil, current_document_update_time: nil, mask_field_paths: nil, update_mask_field_paths: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
761
|
+
def patch_project_database_document(name, document_object = nil, current_document_exists: nil, current_document_update_time: nil, mask_field_paths: nil, request_options_request_tags: nil, update_mask_field_paths: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
729
762
|
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
730
763
|
command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
|
731
764
|
command.request_object = document_object
|
|
@@ -735,6 +768,7 @@ module Google
|
|
|
735
768
|
command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
|
|
736
769
|
command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
|
|
737
770
|
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
|
771
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
738
772
|
command.query['updateMask.fieldPaths'] = update_mask_field_paths unless update_mask_field_paths.nil?
|
|
739
773
|
command.query['fields'] = fields unless fields.nil?
|
|
740
774
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-apis-firestore_v1beta1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.53.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
@@ -57,7 +57,7 @@ licenses:
|
|
|
57
57
|
metadata:
|
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1/CHANGELOG.md
|
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.
|
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.53.0
|
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
|
|
62
62
|
rdoc_options: []
|
|
63
63
|
require_paths:
|