google-apis-firestore_v1beta1 0.54.0 → 0.56.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/CHANGELOG.md +8 -0
- data/lib/google/apis/firestore_v1beta1/classes.rb +140 -6
- data/lib/google/apis/firestore_v1beta1/gem_version.rb +2 -2
- data/lib/google/apis/firestore_v1beta1/representations.rb +40 -0
- data/lib/google/apis/firestore_v1beta1/service.rb +144 -6
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 88fc6263869932e29144b5e0f58f73a8405051f8443babafadbd150a7846a628
|
|
4
|
+
data.tar.gz: c3725e69ee08704f2d268b950b360e8f8827f7434a986f03b6abaebc58cdbdb3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c0ae552a0bef900666d6a4d0aa4c6700cdd567e6494f931b77cd1637734d75603fd1a31c07c2ac7e3f65d54508f20c535a0bbaa841c5296beea82ea3521248c1
|
|
7
|
+
data.tar.gz: 5e129a40feae70e69fbe4af777daf63fdeb96fffd5c3d360631e8704939462690b68bd1d55c1f9e685fce3f3b38c7f7ae89373e38680a8068f6c243c65804313
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Release history for google-apis-firestore_v1beta1
|
|
2
2
|
|
|
3
|
+
### v0.56.0 (2026-08-30)
|
|
4
|
+
|
|
5
|
+
* Regenerated from discovery document revision 20260818
|
|
6
|
+
|
|
7
|
+
### v0.55.0 (2026-08-23)
|
|
8
|
+
|
|
9
|
+
* Regenerated from discovery document revision 20260810
|
|
10
|
+
|
|
3
11
|
### v0.54.0 (2026-07-19)
|
|
4
12
|
|
|
5
13
|
* Regenerated from discovery document revision 20260706
|
|
@@ -180,6 +180,11 @@ module Google
|
|
|
180
180
|
# @return [String]
|
|
181
181
|
attr_accessor :read_time
|
|
182
182
|
|
|
183
|
+
# Options for a 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 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 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 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
|
|
@@ -851,6 +875,11 @@ module Google
|
|
|
851
875
|
# @return [String]
|
|
852
876
|
attr_accessor :read_time
|
|
853
877
|
|
|
878
|
+
# Options for a request.
|
|
879
|
+
# Corresponds to the JSON property `requestOptions`
|
|
880
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
881
|
+
attr_accessor :request_options
|
|
882
|
+
|
|
854
883
|
# A Firestore query represented as an ordered list of operations / stages. This
|
|
855
884
|
# is considered the top-level function which plans and executes a query. It is
|
|
856
885
|
# logically equivalent to `query(stages, options)`, but prevents the client from
|
|
@@ -875,12 +904,13 @@ module Google
|
|
|
875
904
|
@auto_commit_transaction = args[:auto_commit_transaction] if args.key?(:auto_commit_transaction)
|
|
876
905
|
@new_transaction = args[:new_transaction] if args.key?(:new_transaction)
|
|
877
906
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
907
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
878
908
|
@structured_pipeline = args[:structured_pipeline] if args.key?(:structured_pipeline)
|
|
879
909
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
880
910
|
end
|
|
881
911
|
end
|
|
882
912
|
|
|
883
|
-
# The response for Firestore.
|
|
913
|
+
# The response for Firestore.ExecutePipeline.
|
|
884
914
|
class ExecutePipelineResponse
|
|
885
915
|
include Google::Apis::Core::Hashable
|
|
886
916
|
|
|
@@ -1583,12 +1613,31 @@ module Google
|
|
|
1583
1613
|
class GoogleFirestoreAdminV1UpdateDatabaseMetadata
|
|
1584
1614
|
include Google::Apis::Core::Hashable
|
|
1585
1615
|
|
|
1616
|
+
# The time this operation completed. Will be unset if operation still in
|
|
1617
|
+
# progress.
|
|
1618
|
+
# Corresponds to the JSON property `endTime`
|
|
1619
|
+
# @return [String]
|
|
1620
|
+
attr_accessor :end_time
|
|
1621
|
+
|
|
1622
|
+
# The time this operation started.
|
|
1623
|
+
# Corresponds to the JSON property `startTime`
|
|
1624
|
+
# @return [String]
|
|
1625
|
+
attr_accessor :start_time
|
|
1626
|
+
|
|
1627
|
+
# The state of the operation.
|
|
1628
|
+
# Corresponds to the JSON property `state`
|
|
1629
|
+
# @return [String]
|
|
1630
|
+
attr_accessor :state
|
|
1631
|
+
|
|
1586
1632
|
def initialize(**args)
|
|
1587
1633
|
update!(**args)
|
|
1588
1634
|
end
|
|
1589
1635
|
|
|
1590
1636
|
# Update properties of this object
|
|
1591
1637
|
def update!(**args)
|
|
1638
|
+
@end_time = args[:end_time] if args.key?(:end_time)
|
|
1639
|
+
@start_time = args[:start_time] if args.key?(:start_time)
|
|
1640
|
+
@state = args[:state] if args.key?(:state)
|
|
1592
1641
|
end
|
|
1593
1642
|
end
|
|
1594
1643
|
|
|
@@ -2080,6 +2129,11 @@ module Google
|
|
|
2080
2129
|
# @return [String]
|
|
2081
2130
|
attr_accessor :read_time
|
|
2082
2131
|
|
|
2132
|
+
# Options for a request.
|
|
2133
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2134
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2135
|
+
attr_accessor :request_options
|
|
2136
|
+
|
|
2083
2137
|
def initialize(**args)
|
|
2084
2138
|
update!(**args)
|
|
2085
2139
|
end
|
|
@@ -2089,6 +2143,7 @@ module Google
|
|
|
2089
2143
|
@page_size = args[:page_size] if args.key?(:page_size)
|
|
2090
2144
|
@page_token = args[:page_token] if args.key?(:page_token)
|
|
2091
2145
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2146
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2092
2147
|
end
|
|
2093
2148
|
end
|
|
2094
2149
|
|
|
@@ -2162,6 +2217,11 @@ module Google
|
|
|
2162
2217
|
# @return [Fixnum]
|
|
2163
2218
|
attr_accessor :remove_target
|
|
2164
2219
|
|
|
2220
|
+
# Options for a request.
|
|
2221
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2222
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2223
|
+
attr_accessor :request_options
|
|
2224
|
+
|
|
2165
2225
|
def initialize(**args)
|
|
2166
2226
|
update!(**args)
|
|
2167
2227
|
end
|
|
@@ -2171,6 +2231,7 @@ module Google
|
|
|
2171
2231
|
@add_target = args[:add_target] if args.key?(:add_target)
|
|
2172
2232
|
@labels = args[:labels] if args.key?(:labels)
|
|
2173
2233
|
@remove_target = args[:remove_target] if args.key?(:remove_target)
|
|
2234
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2174
2235
|
end
|
|
2175
2236
|
end
|
|
2176
2237
|
|
|
@@ -2317,6 +2378,11 @@ module Google
|
|
|
2317
2378
|
# @return [String]
|
|
2318
2379
|
attr_accessor :read_time
|
|
2319
2380
|
|
|
2381
|
+
# Options for a request.
|
|
2382
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2383
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2384
|
+
attr_accessor :request_options
|
|
2385
|
+
|
|
2320
2386
|
# A Firestore query. The query stages are executed in the following order: 1.
|
|
2321
2387
|
# from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
|
|
2322
2388
|
# find_nearest
|
|
@@ -2334,6 +2400,7 @@ module Google
|
|
|
2334
2400
|
@page_token = args[:page_token] if args.key?(:page_token)
|
|
2335
2401
|
@partition_count = args[:partition_count] if args.key?(:partition_count)
|
|
2336
2402
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2403
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2337
2404
|
@structured_query = args[:structured_query] if args.key?(:structured_query)
|
|
2338
2405
|
end
|
|
2339
2406
|
end
|
|
@@ -2544,10 +2611,54 @@ module Google
|
|
|
2544
2611
|
end
|
|
2545
2612
|
end
|
|
2546
2613
|
|
|
2614
|
+
# Options for a request.
|
|
2615
|
+
class RequestOptions
|
|
2616
|
+
include Google::Apis::Core::Hashable
|
|
2617
|
+
|
|
2618
|
+
# Optional. The request tags for the request. Request tags are user-provided
|
|
2619
|
+
# strings used for usage monitoring, cost management, and observability. Callers
|
|
2620
|
+
# can associate custom application context (such as component, microservice,
|
|
2621
|
+
# feature name, or operation type) with database requests. These tags are
|
|
2622
|
+
# collected and aggregated in usage and monitoring reports, allowing billable
|
|
2623
|
+
# operations and usage metrics to be sliced and analyzed by tag. These tags *
|
|
2624
|
+
# only* show up in monitoring and are visible in administrative operations (such
|
|
2625
|
+
# as usage reports). They do not affect data storage, query semantics, or
|
|
2626
|
+
# request execution. Cardinality and Best Practices: - Request tags are most
|
|
2627
|
+
# effective when using a bounded set of distinct values (e.g., fewer than 100
|
|
2628
|
+
# distinct tags across an entire database). Using a large number of distinct
|
|
2629
|
+
# tags may result in tags being omitted from top usage dashboards. - Use
|
|
2630
|
+
# structured identifiers (for example: `app=cart`, `env=prod`, `service=checkout`
|
|
2631
|
+
# ) and avoid high-cardinality values such as UUIDs, request IDs, timestamps,
|
|
2632
|
+
# user IDs, or document keys. - Do not include sensitive data or personally
|
|
2633
|
+
# identifiable information (PII) in request tags, as they show up in
|
|
2634
|
+
# administrative monitoring. The tags are processed as follows: - Leading and
|
|
2635
|
+
# trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out.
|
|
2636
|
+
# - Truncated to a maximum of 510 characters. - Deduplicated within the same
|
|
2637
|
+
# request. - Limited to a maximum of 50 tags per request (excess tags are
|
|
2638
|
+
# silently discarded).
|
|
2639
|
+
# Corresponds to the JSON property `requestTags`
|
|
2640
|
+
# @return [Array<String>]
|
|
2641
|
+
attr_accessor :request_tags
|
|
2642
|
+
|
|
2643
|
+
def initialize(**args)
|
|
2644
|
+
update!(**args)
|
|
2645
|
+
end
|
|
2646
|
+
|
|
2647
|
+
# Update properties of this object
|
|
2648
|
+
def update!(**args)
|
|
2649
|
+
@request_tags = args[:request_tags] if args.key?(:request_tags)
|
|
2650
|
+
end
|
|
2651
|
+
end
|
|
2652
|
+
|
|
2547
2653
|
# The request for Firestore.Rollback.
|
|
2548
2654
|
class RollbackRequest
|
|
2549
2655
|
include Google::Apis::Core::Hashable
|
|
2550
2656
|
|
|
2657
|
+
# Options for a request.
|
|
2658
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2659
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2660
|
+
attr_accessor :request_options
|
|
2661
|
+
|
|
2551
2662
|
# Required. The transaction to roll back.
|
|
2552
2663
|
# Corresponds to the JSON property `transaction`
|
|
2553
2664
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
@@ -2560,6 +2671,7 @@ module Google
|
|
|
2560
2671
|
|
|
2561
2672
|
# Update properties of this object
|
|
2562
2673
|
def update!(**args)
|
|
2674
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2563
2675
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
2564
2676
|
end
|
|
2565
2677
|
end
|
|
@@ -2585,6 +2697,11 @@ module Google
|
|
|
2585
2697
|
# @return [String]
|
|
2586
2698
|
attr_accessor :read_time
|
|
2587
2699
|
|
|
2700
|
+
# Options for a request.
|
|
2701
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2702
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2703
|
+
attr_accessor :request_options
|
|
2704
|
+
|
|
2588
2705
|
# Firestore query for running an aggregation over a StructuredQuery.
|
|
2589
2706
|
# Corresponds to the JSON property `structuredAggregationQuery`
|
|
2590
2707
|
# @return [Google::Apis::FirestoreV1beta1::StructuredAggregationQuery]
|
|
@@ -2606,6 +2723,7 @@ module Google
|
|
|
2606
2723
|
@explain_options = args[:explain_options] if args.key?(:explain_options)
|
|
2607
2724
|
@new_transaction = args[:new_transaction] if args.key?(:new_transaction)
|
|
2608
2725
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2726
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2609
2727
|
@structured_aggregation_query = args[:structured_aggregation_query] if args.key?(:structured_aggregation_query)
|
|
2610
2728
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
2611
2729
|
end
|
|
@@ -2677,6 +2795,11 @@ module Google
|
|
|
2677
2795
|
# @return [String]
|
|
2678
2796
|
attr_accessor :read_time
|
|
2679
2797
|
|
|
2798
|
+
# Options for a request.
|
|
2799
|
+
# Corresponds to the JSON property `requestOptions`
|
|
2800
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
2801
|
+
attr_accessor :request_options
|
|
2802
|
+
|
|
2680
2803
|
# A Firestore query. The query stages are executed in the following order: 1.
|
|
2681
2804
|
# from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
|
|
2682
2805
|
# find_nearest
|
|
@@ -2700,6 +2823,7 @@ module Google
|
|
|
2700
2823
|
@explain_options = args[:explain_options] if args.key?(:explain_options)
|
|
2701
2824
|
@new_transaction = args[:new_transaction] if args.key?(:new_transaction)
|
|
2702
2825
|
@read_time = args[:read_time] if args.key?(:read_time)
|
|
2826
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
2703
2827
|
@structured_query = args[:structured_query] if args.key?(:structured_query)
|
|
2704
2828
|
@transaction = args[:transaction] if args.key?(:transaction)
|
|
2705
2829
|
end
|
|
@@ -3217,8 +3341,10 @@ module Google
|
|
|
3217
3341
|
attr_accessor :boolean_value
|
|
3218
3342
|
alias_method :boolean_value?, :boolean_value
|
|
3219
3343
|
|
|
3220
|
-
# A bytes value.
|
|
3221
|
-
# are considered by queries.
|
|
3344
|
+
# A bytes value. In Standard edition databases: * The value must not exceed 1
|
|
3345
|
+
# MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In
|
|
3346
|
+
# Enterprise edition databases, there is no limit on the size of the value.
|
|
3347
|
+
# However, it is still subject to document and index entry size limits.
|
|
3222
3348
|
# Corresponds to the JSON property `bytesValue`
|
|
3223
3349
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
3224
3350
|
# @return [String]
|
|
@@ -3278,9 +3404,11 @@ module Google
|
|
|
3278
3404
|
# @return [String]
|
|
3279
3405
|
attr_accessor :reference_value
|
|
3280
3406
|
|
|
3281
|
-
# A string value. The string, represented as
|
|
3282
|
-
# bytes. Only the first 1,500 bytes of the
|
|
3283
|
-
# by queries.
|
|
3407
|
+
# A string value. In Standard edition databases: * The string, represented as
|
|
3408
|
+
# UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the
|
|
3409
|
+
# UTF-8 representation are considered by queries. In Enterprise edition
|
|
3410
|
+
# databases, there is no limit on the size of the value. However, it is still
|
|
3411
|
+
# subject to document and index entry size limits.
|
|
3284
3412
|
# Corresponds to the JSON property `stringValue`
|
|
3285
3413
|
# @return [String]
|
|
3286
3414
|
attr_accessor :string_value
|
|
@@ -3391,6 +3519,11 @@ module Google
|
|
|
3391
3519
|
# @return [Hash<String,String>]
|
|
3392
3520
|
attr_accessor :labels
|
|
3393
3521
|
|
|
3522
|
+
# Options for a request.
|
|
3523
|
+
# Corresponds to the JSON property `requestOptions`
|
|
3524
|
+
# @return [Google::Apis::FirestoreV1beta1::RequestOptions]
|
|
3525
|
+
attr_accessor :request_options
|
|
3526
|
+
|
|
3394
3527
|
# The ID of the write stream to resume. This may only be set in the first
|
|
3395
3528
|
# message. When left empty, a new write stream will be created.
|
|
3396
3529
|
# Corresponds to the JSON property `streamId`
|
|
@@ -3424,6 +3557,7 @@ module Google
|
|
|
3424
3557
|
# Update properties of this object
|
|
3425
3558
|
def update!(**args)
|
|
3426
3559
|
@labels = args[:labels] if args.key?(:labels)
|
|
3560
|
+
@request_options = args[:request_options] if args.key?(:request_options)
|
|
3427
3561
|
@stream_id = args[:stream_id] if args.key?(:stream_id)
|
|
3428
3562
|
@stream_token = args[:stream_token] if args.key?(:stream_token)
|
|
3429
3563
|
@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.56.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 = "20260818"
|
|
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
|
|
|
@@ -836,6 +850,8 @@ module Google
|
|
|
836
850
|
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
837
851
|
|
|
838
852
|
property :read_time, as: 'readTime'
|
|
853
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
854
|
+
|
|
839
855
|
property :structured_pipeline, as: 'structuredPipeline', class: Google::Apis::FirestoreV1beta1::StructuredPipeline, decorator: Google::Apis::FirestoreV1beta1::StructuredPipeline::Representation
|
|
840
856
|
|
|
841
857
|
property :transaction, :base64 => true, as: 'transaction'
|
|
@@ -1046,6 +1062,9 @@ module Google
|
|
|
1046
1062
|
class GoogleFirestoreAdminV1UpdateDatabaseMetadata
|
|
1047
1063
|
# @private
|
|
1048
1064
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1065
|
+
property :end_time, as: 'endTime'
|
|
1066
|
+
property :start_time, as: 'startTime'
|
|
1067
|
+
property :state, as: 'state'
|
|
1049
1068
|
end
|
|
1050
1069
|
end
|
|
1051
1070
|
|
|
@@ -1183,6 +1202,8 @@ module Google
|
|
|
1183
1202
|
property :page_size, as: 'pageSize'
|
|
1184
1203
|
property :page_token, as: 'pageToken'
|
|
1185
1204
|
property :read_time, as: 'readTime'
|
|
1205
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1206
|
+
|
|
1186
1207
|
end
|
|
1187
1208
|
end
|
|
1188
1209
|
|
|
@@ -1210,6 +1231,8 @@ module Google
|
|
|
1210
1231
|
|
|
1211
1232
|
hash :labels, as: 'labels'
|
|
1212
1233
|
property :remove_target, as: 'removeTarget'
|
|
1234
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1235
|
+
|
|
1213
1236
|
end
|
|
1214
1237
|
end
|
|
1215
1238
|
|
|
@@ -1253,6 +1276,8 @@ module Google
|
|
|
1253
1276
|
property :page_token, as: 'pageToken'
|
|
1254
1277
|
property :partition_count, :numeric_string => true, as: 'partitionCount'
|
|
1255
1278
|
property :read_time, as: 'readTime'
|
|
1279
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1280
|
+
|
|
1256
1281
|
property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
|
|
1257
1282
|
|
|
1258
1283
|
end
|
|
@@ -1322,9 +1347,18 @@ module Google
|
|
|
1322
1347
|
end
|
|
1323
1348
|
end
|
|
1324
1349
|
|
|
1350
|
+
class RequestOptions
|
|
1351
|
+
# @private
|
|
1352
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1353
|
+
collection :request_tags, as: 'requestTags'
|
|
1354
|
+
end
|
|
1355
|
+
end
|
|
1356
|
+
|
|
1325
1357
|
class RollbackRequest
|
|
1326
1358
|
# @private
|
|
1327
1359
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1360
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1361
|
+
|
|
1328
1362
|
property :transaction, :base64 => true, as: 'transaction'
|
|
1329
1363
|
end
|
|
1330
1364
|
end
|
|
@@ -1337,6 +1371,8 @@ module Google
|
|
|
1337
1371
|
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
1338
1372
|
|
|
1339
1373
|
property :read_time, as: 'readTime'
|
|
1374
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1375
|
+
|
|
1340
1376
|
property :structured_aggregation_query, as: 'structuredAggregationQuery', class: Google::Apis::FirestoreV1beta1::StructuredAggregationQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredAggregationQuery::Representation
|
|
1341
1377
|
|
|
1342
1378
|
property :transaction, :base64 => true, as: 'transaction'
|
|
@@ -1363,6 +1399,8 @@ module Google
|
|
|
1363
1399
|
property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1beta1::TransactionOptions, decorator: Google::Apis::FirestoreV1beta1::TransactionOptions::Representation
|
|
1364
1400
|
|
|
1365
1401
|
property :read_time, as: 'readTime'
|
|
1402
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1403
|
+
|
|
1366
1404
|
property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
|
|
1367
1405
|
|
|
1368
1406
|
property :transaction, :base64 => true, as: 'transaction'
|
|
@@ -1546,6 +1584,8 @@ module Google
|
|
|
1546
1584
|
# @private
|
|
1547
1585
|
class Representation < Google::Apis::Core::JsonRepresentation
|
|
1548
1586
|
hash :labels, as: 'labels'
|
|
1587
|
+
property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1beta1::RequestOptions, decorator: Google::Apis::FirestoreV1beta1::RequestOptions::Representation
|
|
1588
|
+
|
|
1549
1589
|
property :stream_id, as: 'streamId'
|
|
1550
1590
|
property :stream_token, :base64 => true, as: 'streamToken'
|
|
1551
1591
|
collection :writes, as: 'writes', class: Google::Apis::FirestoreV1beta1::Write, decorator: Google::Apis::FirestoreV1beta1::Write::Representation
|
|
@@ -286,6 +286,28 @@ 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. Request tags are user-provided
|
|
291
|
+
# strings used for usage monitoring, cost management, and observability. Callers
|
|
292
|
+
# can associate custom application context (such as component, microservice,
|
|
293
|
+
# feature name, or operation type) with database requests. These tags are
|
|
294
|
+
# collected and aggregated in usage and monitoring reports, allowing billable
|
|
295
|
+
# operations and usage metrics to be sliced and analyzed by tag. These tags *
|
|
296
|
+
# only* show up in monitoring and are visible in administrative operations (such
|
|
297
|
+
# as usage reports). They do not affect data storage, query semantics, or
|
|
298
|
+
# request execution. Cardinality and Best Practices: - Request tags are most
|
|
299
|
+
# effective when using a bounded set of distinct values (e.g., fewer than 100
|
|
300
|
+
# distinct tags across an entire database). Using a large number of distinct
|
|
301
|
+
# tags may result in tags being omitted from top usage dashboards. - Use
|
|
302
|
+
# structured identifiers (for example: `app=cart`, `env=prod`, `service=checkout`
|
|
303
|
+
# ) and avoid high-cardinality values such as UUIDs, request IDs, timestamps,
|
|
304
|
+
# user IDs, or document keys. - Do not include sensitive data or personally
|
|
305
|
+
# identifiable information (PII) in request tags, as they show up in
|
|
306
|
+
# administrative monitoring. The tags are processed as follows: - Leading and
|
|
307
|
+
# trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out.
|
|
308
|
+
# - Truncated to a maximum of 510 characters. - Deduplicated within the same
|
|
309
|
+
# request. - Limited to a maximum of 50 tags per request (excess tags are
|
|
310
|
+
# silently discarded).
|
|
289
311
|
# @param [String] fields
|
|
290
312
|
# Selector specifying which fields to include in a partial response.
|
|
291
313
|
# @param [String] quota_user
|
|
@@ -303,7 +325,7 @@ module Google
|
|
|
303
325
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
304
326
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
305
327
|
# @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)
|
|
328
|
+
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
329
|
command = make_simple_command(:post, 'v1beta1/{+parent}/{collectionId}', options)
|
|
308
330
|
command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
|
309
331
|
command.request_object = document_object
|
|
@@ -313,6 +335,7 @@ module Google
|
|
|
313
335
|
command.params['collectionId'] = collection_id unless collection_id.nil?
|
|
314
336
|
command.query['documentId'] = document_id unless document_id.nil?
|
|
315
337
|
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
|
338
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
316
339
|
command.query['fields'] = fields unless fields.nil?
|
|
317
340
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
318
341
|
execute_or_queue_command(command, &block)
|
|
@@ -328,6 +351,28 @@ module Google
|
|
|
328
351
|
# @param [String] current_document_update_time
|
|
329
352
|
# When set, the target document must exist and have been last updated at that
|
|
330
353
|
# time. Timestamp must be microsecond aligned.
|
|
354
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
355
|
+
# Optional. The request tags for the request. Request tags are user-provided
|
|
356
|
+
# strings used for usage monitoring, cost management, and observability. Callers
|
|
357
|
+
# can associate custom application context (such as component, microservice,
|
|
358
|
+
# feature name, or operation type) with database requests. These tags are
|
|
359
|
+
# collected and aggregated in usage and monitoring reports, allowing billable
|
|
360
|
+
# operations and usage metrics to be sliced and analyzed by tag. These tags *
|
|
361
|
+
# only* show up in monitoring and are visible in administrative operations (such
|
|
362
|
+
# as usage reports). They do not affect data storage, query semantics, or
|
|
363
|
+
# request execution. Cardinality and Best Practices: - Request tags are most
|
|
364
|
+
# effective when using a bounded set of distinct values (e.g., fewer than 100
|
|
365
|
+
# distinct tags across an entire database). Using a large number of distinct
|
|
366
|
+
# tags may result in tags being omitted from top usage dashboards. - Use
|
|
367
|
+
# structured identifiers (for example: `app=cart`, `env=prod`, `service=checkout`
|
|
368
|
+
# ) and avoid high-cardinality values such as UUIDs, request IDs, timestamps,
|
|
369
|
+
# user IDs, or document keys. - Do not include sensitive data or personally
|
|
370
|
+
# identifiable information (PII) in request tags, as they show up in
|
|
371
|
+
# administrative monitoring. The tags are processed as follows: - Leading and
|
|
372
|
+
# trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out.
|
|
373
|
+
# - Truncated to a maximum of 510 characters. - Deduplicated within the same
|
|
374
|
+
# request. - Limited to a maximum of 50 tags per request (excess tags are
|
|
375
|
+
# silently discarded).
|
|
331
376
|
# @param [String] fields
|
|
332
377
|
# Selector specifying which fields to include in a partial response.
|
|
333
378
|
# @param [String] quota_user
|
|
@@ -345,13 +390,14 @@ module Google
|
|
|
345
390
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
346
391
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
347
392
|
# @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)
|
|
393
|
+
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
394
|
command = make_simple_command(:delete, 'v1beta1/{+name}', options)
|
|
350
395
|
command.response_representation = Google::Apis::FirestoreV1beta1::Empty::Representation
|
|
351
396
|
command.response_class = Google::Apis::FirestoreV1beta1::Empty
|
|
352
397
|
command.params['name'] = name unless name.nil?
|
|
353
398
|
command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
|
|
354
399
|
command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
|
|
400
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
355
401
|
command.query['fields'] = fields unless fields.nil?
|
|
356
402
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
357
403
|
execute_or_queue_command(command, &block)
|
|
@@ -403,6 +449,28 @@ module Google
|
|
|
403
449
|
# microsecond precision timestamp within the past one hour, or if Point-in-Time
|
|
404
450
|
# Recovery is enabled, can additionally be a whole minute timestamp within the
|
|
405
451
|
# past 7 days.
|
|
452
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
453
|
+
# Optional. The request tags for the request. Request tags are user-provided
|
|
454
|
+
# strings used for usage monitoring, cost management, and observability. Callers
|
|
455
|
+
# can associate custom application context (such as component, microservice,
|
|
456
|
+
# feature name, or operation type) with database requests. These tags are
|
|
457
|
+
# collected and aggregated in usage and monitoring reports, allowing billable
|
|
458
|
+
# operations and usage metrics to be sliced and analyzed by tag. These tags *
|
|
459
|
+
# only* show up in monitoring and are visible in administrative operations (such
|
|
460
|
+
# as usage reports). They do not affect data storage, query semantics, or
|
|
461
|
+
# request execution. Cardinality and Best Practices: - Request tags are most
|
|
462
|
+
# effective when using a bounded set of distinct values (e.g., fewer than 100
|
|
463
|
+
# distinct tags across an entire database). Using a large number of distinct
|
|
464
|
+
# tags may result in tags being omitted from top usage dashboards. - Use
|
|
465
|
+
# structured identifiers (for example: `app=cart`, `env=prod`, `service=checkout`
|
|
466
|
+
# ) and avoid high-cardinality values such as UUIDs, request IDs, timestamps,
|
|
467
|
+
# user IDs, or document keys. - Do not include sensitive data or personally
|
|
468
|
+
# identifiable information (PII) in request tags, as they show up in
|
|
469
|
+
# administrative monitoring. The tags are processed as follows: - Leading and
|
|
470
|
+
# trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out.
|
|
471
|
+
# - Truncated to a maximum of 510 characters. - Deduplicated within the same
|
|
472
|
+
# request. - Limited to a maximum of 50 tags per request (excess tags are
|
|
473
|
+
# silently discarded).
|
|
406
474
|
# @param [String] transaction
|
|
407
475
|
# Reads the document in a transaction.
|
|
408
476
|
# @param [String] fields
|
|
@@ -422,13 +490,14 @@ module Google
|
|
|
422
490
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
423
491
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
424
492
|
# @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)
|
|
493
|
+
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
494
|
command = make_simple_command(:get, 'v1beta1/{+name}', options)
|
|
427
495
|
command.response_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
|
428
496
|
command.response_class = Google::Apis::FirestoreV1beta1::Document
|
|
429
497
|
command.params['name'] = name unless name.nil?
|
|
430
498
|
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
|
431
499
|
command.query['readTime'] = read_time unless read_time.nil?
|
|
500
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
432
501
|
command.query['transaction'] = transaction unless transaction.nil?
|
|
433
502
|
command.query['fields'] = fields unless fields.nil?
|
|
434
503
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
@@ -473,6 +542,28 @@ module Google
|
|
|
473
542
|
# This is optional, and when not provided, Firestore will only list documents
|
|
474
543
|
# nested immediately under the parent. Requests with `recursive` may not specify
|
|
475
544
|
# `show_missing`.
|
|
545
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
546
|
+
# Optional. The request tags for the request. Request tags are user-provided
|
|
547
|
+
# strings used for usage monitoring, cost management, and observability. Callers
|
|
548
|
+
# can associate custom application context (such as component, microservice,
|
|
549
|
+
# feature name, or operation type) with database requests. These tags are
|
|
550
|
+
# collected and aggregated in usage and monitoring reports, allowing billable
|
|
551
|
+
# operations and usage metrics to be sliced and analyzed by tag. These tags *
|
|
552
|
+
# only* show up in monitoring and are visible in administrative operations (such
|
|
553
|
+
# as usage reports). They do not affect data storage, query semantics, or
|
|
554
|
+
# request execution. Cardinality and Best Practices: - Request tags are most
|
|
555
|
+
# effective when using a bounded set of distinct values (e.g., fewer than 100
|
|
556
|
+
# distinct tags across an entire database). Using a large number of distinct
|
|
557
|
+
# tags may result in tags being omitted from top usage dashboards. - Use
|
|
558
|
+
# structured identifiers (for example: `app=cart`, `env=prod`, `service=checkout`
|
|
559
|
+
# ) and avoid high-cardinality values such as UUIDs, request IDs, timestamps,
|
|
560
|
+
# user IDs, or document keys. - Do not include sensitive data or personally
|
|
561
|
+
# identifiable information (PII) in request tags, as they show up in
|
|
562
|
+
# administrative monitoring. The tags are processed as follows: - Leading and
|
|
563
|
+
# trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out.
|
|
564
|
+
# - Truncated to a maximum of 510 characters. - Deduplicated within the same
|
|
565
|
+
# request. - Limited to a maximum of 50 tags per request (excess tags are
|
|
566
|
+
# silently discarded).
|
|
476
567
|
# @param [Boolean] show_missing
|
|
477
568
|
# If the list should show missing documents. A document is missing if it does
|
|
478
569
|
# not exist, but there are sub-documents nested underneath it. When true, such
|
|
@@ -498,7 +589,7 @@ module Google
|
|
|
498
589
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
499
590
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
500
591
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
501
|
-
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, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
592
|
+
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)
|
|
502
593
|
command = make_simple_command(:get, 'v1beta1/{+parent}/{collectionId}', options)
|
|
503
594
|
command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
|
|
504
595
|
command.response_class = Google::Apis::FirestoreV1beta1::ListDocumentsResponse
|
|
@@ -510,6 +601,7 @@ module Google
|
|
|
510
601
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
511
602
|
command.query['readTime'] = read_time unless read_time.nil?
|
|
512
603
|
command.query['recursive'] = recursive unless recursive.nil?
|
|
604
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
513
605
|
command.query['showMissing'] = show_missing unless show_missing.nil?
|
|
514
606
|
command.query['transaction'] = transaction unless transaction.nil?
|
|
515
607
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -591,6 +683,28 @@ module Google
|
|
|
591
683
|
# This is optional, and when not provided, Firestore will only list documents
|
|
592
684
|
# nested immediately under the parent. Requests with `recursive` may not specify
|
|
593
685
|
# `show_missing`.
|
|
686
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
687
|
+
# Optional. The request tags for the request. Request tags are user-provided
|
|
688
|
+
# strings used for usage monitoring, cost management, and observability. Callers
|
|
689
|
+
# can associate custom application context (such as component, microservice,
|
|
690
|
+
# feature name, or operation type) with database requests. These tags are
|
|
691
|
+
# collected and aggregated in usage and monitoring reports, allowing billable
|
|
692
|
+
# operations and usage metrics to be sliced and analyzed by tag. These tags *
|
|
693
|
+
# only* show up in monitoring and are visible in administrative operations (such
|
|
694
|
+
# as usage reports). They do not affect data storage, query semantics, or
|
|
695
|
+
# request execution. Cardinality and Best Practices: - Request tags are most
|
|
696
|
+
# effective when using a bounded set of distinct values (e.g., fewer than 100
|
|
697
|
+
# distinct tags across an entire database). Using a large number of distinct
|
|
698
|
+
# tags may result in tags being omitted from top usage dashboards. - Use
|
|
699
|
+
# structured identifiers (for example: `app=cart`, `env=prod`, `service=checkout`
|
|
700
|
+
# ) and avoid high-cardinality values such as UUIDs, request IDs, timestamps,
|
|
701
|
+
# user IDs, or document keys. - Do not include sensitive data or personally
|
|
702
|
+
# identifiable information (PII) in request tags, as they show up in
|
|
703
|
+
# administrative monitoring. The tags are processed as follows: - Leading and
|
|
704
|
+
# trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out.
|
|
705
|
+
# - Truncated to a maximum of 510 characters. - Deduplicated within the same
|
|
706
|
+
# request. - Limited to a maximum of 50 tags per request (excess tags are
|
|
707
|
+
# silently discarded).
|
|
594
708
|
# @param [Boolean] show_missing
|
|
595
709
|
# If the list should show missing documents. A document is missing if it does
|
|
596
710
|
# not exist, but there are sub-documents nested underneath it. When true, such
|
|
@@ -616,7 +730,7 @@ module Google
|
|
|
616
730
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
617
731
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
618
732
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
619
|
-
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, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
|
|
733
|
+
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)
|
|
620
734
|
command = make_simple_command(:get, 'v1beta1/{+parent}/{collectionId}', options)
|
|
621
735
|
command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
|
|
622
736
|
command.response_class = Google::Apis::FirestoreV1beta1::ListDocumentsResponse
|
|
@@ -628,6 +742,7 @@ module Google
|
|
|
628
742
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
629
743
|
command.query['readTime'] = read_time unless read_time.nil?
|
|
630
744
|
command.query['recursive'] = recursive unless recursive.nil?
|
|
745
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
631
746
|
command.query['showMissing'] = show_missing unless show_missing.nil?
|
|
632
747
|
command.query['transaction'] = transaction unless transaction.nil?
|
|
633
748
|
command.query['fields'] = fields unless fields.nil?
|
|
@@ -721,6 +836,28 @@ module Google
|
|
|
721
836
|
# @param [Array<String>, String] mask_field_paths
|
|
722
837
|
# The list of field paths in the mask. See Document.fields for a field path
|
|
723
838
|
# syntax reference.
|
|
839
|
+
# @param [Array<String>, String] request_options_request_tags
|
|
840
|
+
# Optional. The request tags for the request. Request tags are user-provided
|
|
841
|
+
# strings used for usage monitoring, cost management, and observability. Callers
|
|
842
|
+
# can associate custom application context (such as component, microservice,
|
|
843
|
+
# feature name, or operation type) with database requests. These tags are
|
|
844
|
+
# collected and aggregated in usage and monitoring reports, allowing billable
|
|
845
|
+
# operations and usage metrics to be sliced and analyzed by tag. These tags *
|
|
846
|
+
# only* show up in monitoring and are visible in administrative operations (such
|
|
847
|
+
# as usage reports). They do not affect data storage, query semantics, or
|
|
848
|
+
# request execution. Cardinality and Best Practices: - Request tags are most
|
|
849
|
+
# effective when using a bounded set of distinct values (e.g., fewer than 100
|
|
850
|
+
# distinct tags across an entire database). Using a large number of distinct
|
|
851
|
+
# tags may result in tags being omitted from top usage dashboards. - Use
|
|
852
|
+
# structured identifiers (for example: `app=cart`, `env=prod`, `service=checkout`
|
|
853
|
+
# ) and avoid high-cardinality values such as UUIDs, request IDs, timestamps,
|
|
854
|
+
# user IDs, or document keys. - Do not include sensitive data or personally
|
|
855
|
+
# identifiable information (PII) in request tags, as they show up in
|
|
856
|
+
# administrative monitoring. The tags are processed as follows: - Leading and
|
|
857
|
+
# trailing whitespace is trimmed. - Empty tags (after trimming) are filtered out.
|
|
858
|
+
# - Truncated to a maximum of 510 characters. - Deduplicated within the same
|
|
859
|
+
# request. - Limited to a maximum of 50 tags per request (excess tags are
|
|
860
|
+
# silently discarded).
|
|
724
861
|
# @param [Array<String>, String] update_mask_field_paths
|
|
725
862
|
# The list of field paths in the mask. See Document.fields for a field path
|
|
726
863
|
# syntax reference.
|
|
@@ -741,7 +878,7 @@ module Google
|
|
|
741
878
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
742
879
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
743
880
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
744
|
-
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)
|
|
881
|
+
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)
|
|
745
882
|
command = make_simple_command(:patch, 'v1beta1/{+name}', options)
|
|
746
883
|
command.request_representation = Google::Apis::FirestoreV1beta1::Document::Representation
|
|
747
884
|
command.request_object = document_object
|
|
@@ -751,6 +888,7 @@ module Google
|
|
|
751
888
|
command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
|
|
752
889
|
command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
|
|
753
890
|
command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
|
|
891
|
+
command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
|
|
754
892
|
command.query['updateMask.fieldPaths'] = update_mask_field_paths unless update_mask_field_paths.nil?
|
|
755
893
|
command.query['fields'] = fields unless fields.nil?
|
|
756
894
|
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.56.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.56.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:
|