google-apis-firestore_v1 0.96.0 → 0.98.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: 598cfc9a43ebc1b39f726c34e6708f71346e64ebb3a9a39d25226df6b5a63b6a
4
- data.tar.gz: ae17dd1694fd0303162084281003e1d65792fc2bee7defc5976173ab80561bd6
3
+ metadata.gz: e38fb2c8c7e43e9d57eec4549930966b9d579ccd7b9643c835102310b9156d3b
4
+ data.tar.gz: 774baa20de59cd65f2009ea06f62521b21fe5db143edac628e76658baec352f5
5
5
  SHA512:
6
- metadata.gz: 6fd79fafa859ae0db556243c3f536f7dda421198512fbbe39e0130a67d40109cae245df73c02bcb04cecd28ce90e3ee3a2be9d8f1caab60ea102df0df82f0c1d
7
- data.tar.gz: e1586604bd1084b4d3ab49b9731dceb43f7548e8a12dabf6a525c000ffc5efbf6f6778474e70eb48c5ef8bf582a15717ea7fb96176fdbf4ba381ca909e1a7299
6
+ metadata.gz: 8b5c4ec803932ffe9ddbb6a379c002ba31eef47182d2c1695fd6644070fd398b86f767292858ddded18db9311f58e4ed7bcd127448c3e8be102ed9648c42284f
7
+ data.tar.gz: db9f4b2b99ce8f5c293d37dcdea18ef736e0c8f7bafd662f519d911c78a893a1ddd566db8d3284af4c35b366b36623764a3b1d9d800c5687445a2c8261426600
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-firestore_v1
2
2
 
3
+ ### v0.98.0 (2026-08-23)
4
+
5
+ * Regenerated from discovery document revision 20260810
6
+
7
+ ### v0.97.0 (2026-07-19)
8
+
9
+ * Regenerated from discovery document revision 20260706
10
+
3
11
  ### v0.96.0 (2026-06-21)
4
12
 
5
13
  * Regenerated from discovery document revision 20260608
@@ -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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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::FirestoreV1::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 server request.
879
+ # Corresponds to the JSON property `requestOptions`
880
+ # @return [Google::Apis::FirestoreV1::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.Execute.
913
+ # The response for Firestore.ExecutePipeline.
884
914
  class ExecutePipelineResponse
885
915
  include Google::Apis::Core::Hashable
886
916
 
@@ -1561,6 +1591,77 @@ module Google
1561
1591
  end
1562
1592
  end
1563
1593
 
1594
+ # A Change Stream is a resource that allows users to receive change
1595
+ # notifications from a Firestore database.
1596
+ class GoogleFirestoreAdminV1ChangeStream
1597
+ include Google::Apis::Core::Hashable
1598
+
1599
+ # The change stream is scoped to a collection group. Only events associated with
1600
+ # the given collection group are visible to the Change Stream. Only a single
1601
+ # change stream can be enabled per collection group.
1602
+ # Corresponds to the JSON property `collectionGroupScope`
1603
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CollectionGroupScope]
1604
+ attr_accessor :collection_group_scope
1605
+
1606
+ # Output only. The time the Change Stream was created.
1607
+ # Corresponds to the JSON property `createTime`
1608
+ # @return [String]
1609
+ attr_accessor :create_time
1610
+
1611
+ # The change stream is scoped to the entire database. All events in the database
1612
+ # are visible to the Change Stream. One Database scope Change Stream is allowed
1613
+ # per database.
1614
+ # Corresponds to the JSON property `databaseScope`
1615
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseScope]
1616
+ attr_accessor :database_scope
1617
+
1618
+ # Optional. An etag used to determine which version of the configuration is
1619
+ # being edited.
1620
+ # Corresponds to the JSON property `etag`
1621
+ # @return [String]
1622
+ attr_accessor :etag
1623
+
1624
+ # Identifier. The external resource name of the change stream. Format `projects/`
1625
+ # project`/databases/`database`/changeStreams/`change_stream``
1626
+ # Corresponds to the JSON property `name`
1627
+ # @return [String]
1628
+ attr_accessor :name
1629
+
1630
+ # Required. The retention period of the change stream. This is the amount of
1631
+ # time a change event is available on the change stream. Must be from 1 to 7
1632
+ # days, inclusive. The retention_period must be in day granularity, i.e. it must
1633
+ # be a multiple of 24 hours.
1634
+ # Corresponds to the JSON property `retentionPeriod`
1635
+ # @return [String]
1636
+ attr_accessor :retention_period
1637
+
1638
+ # Output only. The time the Change Stream started recording events.
1639
+ # Corresponds to the JSON property `startTime`
1640
+ # @return [String]
1641
+ attr_accessor :start_time
1642
+
1643
+ # Output only. The time the Change Stream was last updated.
1644
+ # Corresponds to the JSON property `updateTime`
1645
+ # @return [String]
1646
+ attr_accessor :update_time
1647
+
1648
+ def initialize(**args)
1649
+ update!(**args)
1650
+ end
1651
+
1652
+ # Update properties of this object
1653
+ def update!(**args)
1654
+ @collection_group_scope = args[:collection_group_scope] if args.key?(:collection_group_scope)
1655
+ @create_time = args[:create_time] if args.key?(:create_time)
1656
+ @database_scope = args[:database_scope] if args.key?(:database_scope)
1657
+ @etag = args[:etag] if args.key?(:etag)
1658
+ @name = args[:name] if args.key?(:name)
1659
+ @retention_period = args[:retention_period] if args.key?(:retention_period)
1660
+ @start_time = args[:start_time] if args.key?(:start_time)
1661
+ @update_time = args[:update_time] if args.key?(:update_time)
1662
+ end
1663
+ end
1664
+
1564
1665
  # Metadata for the long-running operation from the CloneDatabase request.
1565
1666
  class GoogleFirestoreAdminV1CloneDatabaseMetadata
1566
1667
  include Google::Apis::Core::Hashable
@@ -1701,6 +1802,27 @@ module Google
1701
1802
  end
1702
1803
  end
1703
1804
 
1805
+ # The change stream is scoped to a collection group. Only events associated with
1806
+ # the given collection group are visible to the Change Stream. Only a single
1807
+ # change stream can be enabled per collection group.
1808
+ class GoogleFirestoreAdminV1CollectionGroupScope
1809
+ include Google::Apis::Core::Hashable
1810
+
1811
+ # Required. The collection group name.
1812
+ # Corresponds to the JSON property `collectionGroupId`
1813
+ # @return [String]
1814
+ attr_accessor :collection_group_id
1815
+
1816
+ def initialize(**args)
1817
+ update!(**args)
1818
+ end
1819
+
1820
+ # Update properties of this object
1821
+ def update!(**args)
1822
+ @collection_group_id = args[:collection_group_id] if args.key?(:collection_group_id)
1823
+ end
1824
+ end
1825
+
1704
1826
  # Metadata related to the create database operation.
1705
1827
  class GoogleFirestoreAdminV1CreateDatabaseMetadata
1706
1828
  include Google::Apis::Core::Hashable
@@ -1821,7 +1943,7 @@ module Google
1821
1943
 
1822
1944
  # Optional. The Firestore API data access mode to use for this database. If not
1823
1945
  # set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise
1824
- # Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.
1946
+ # edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard edition.
1825
1947
  # Corresponds to the JSON property `firestoreDataAccessMode`
1826
1948
  # @return [String]
1827
1949
  attr_accessor :firestore_data_access_mode
@@ -1856,8 +1978,8 @@ module Google
1856
1978
 
1857
1979
  # Optional. The MongoDB compatible API data access mode to use for this database.
1858
1980
  # If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for
1859
- # Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard
1860
- # Edition.
1981
+ # Enterprise edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard
1982
+ # edition.
1861
1983
  # Corresponds to the JSON property `mongodbCompatibleDataAccessMode`
1862
1984
  # @return [String]
1863
1985
  attr_accessor :mongodb_compatible_data_access_mode
@@ -1956,6 +2078,21 @@ module Google
1956
2078
  end
1957
2079
  end
1958
2080
 
2081
+ # The change stream is scoped to the entire database. All events in the database
2082
+ # are visible to the Change Stream. One Database scope Change Stream is allowed
2083
+ # per database.
2084
+ class GoogleFirestoreAdminV1DatabaseScope
2085
+ include Google::Apis::Core::Hashable
2086
+
2087
+ def initialize(**args)
2088
+ update!(**args)
2089
+ end
2090
+
2091
+ # Update properties of this object
2092
+ def update!(**args)
2093
+ end
2094
+ end
2095
+
1959
2096
  # Metadata related to the delete database operation.
1960
2097
  class GoogleFirestoreAdminV1DeleteDatabaseMetadata
1961
2098
  include Google::Apis::Core::Hashable
@@ -2427,7 +2564,11 @@ module Google
2427
2564
  end
2428
2565
 
2429
2566
  # Cloud Firestore indexes enable simple and complex queries against documents in
2430
- # a database.
2567
+ # a database. In Standard edition databases, single-field indexes are managed
2568
+ # using the google.firestore.admin.v1.Field resource, and composite indexes are
2569
+ # managed using the google.firestore.admin.v1.Index resource. In Enterprise
2570
+ # edition databases, both single-field and composite indexes are managed using
2571
+ # the google.firestore.admin.v1.Index resource.
2431
2572
  class GoogleFirestoreAdminV1Index
2432
2573
  include Google::Apis::Core::Hashable
2433
2574
 
@@ -2441,14 +2582,13 @@ module Google
2441
2582
  # @return [String]
2442
2583
  attr_accessor :density
2443
2584
 
2444
- # The fields supported by this index. For composite indexes, this requires a
2445
- # minimum of 2 and a maximum of 100 fields. The last field entry is always for
2446
- # the field path `__name__`. If, on creation, `__name__` was not specified as
2447
- # the last field, it will be added automatically with the same direction as that
2448
- # of the last field defined. If the final field in a composite index is not
2449
- # directional, the `__name__` will be ordered ASCENDING (unless explicitly
2450
- # specified). For single field indexes, this will always be exactly one entry
2451
- # with a field path equal to the field path of the associated field.
2585
+ # The fields supported by this index. At most 100 fields may be specified. In
2586
+ # Standard edition databases only: - At least 2 fields must be specified. - The
2587
+ # last field entry is always for the field path `__name__`. If, on creation, `
2588
+ # __name__` was not specified as the last field, it will be added automatically
2589
+ # with the same direction as that of the last field defined. If the final field
2590
+ # in the index is not directional, the `__name__` will be ordered ASCENDING (
2591
+ # unless explicitly specified).
2452
2592
  # Corresponds to the JSON property `fields`
2453
2593
  # @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField>]
2454
2594
  attr_accessor :fields
@@ -2464,10 +2604,11 @@ module Google
2464
2604
  attr_accessor :multikey
2465
2605
  alias_method :multikey?, :multikey
2466
2606
 
2467
- # Output only. A server defined name for this index. The form of this name for
2468
- # composite indexes will be: `projects/`project_id`/databases/`database_id`/
2469
- # collectionGroups/`collection_id`/indexes/`composite_index_id`` For single
2470
- # field indexes, this field will be empty.
2607
+ # A server-defined name for this index. Output only. When used in the google.
2608
+ # firestore.admin.v1.Index resource, the value is of the form: `projects/`
2609
+ # project_id`/databases/`database_id`/collectionGroups/`collection_id`/indexes/`
2610
+ # index_id`` When used in the google.firestore.admin.v1.Field resource, the
2611
+ # value is empty.
2471
2612
  # Corresponds to the JSON property `name`
2472
2613
  # @return [String]
2473
2614
  attr_accessor :name
@@ -2580,7 +2721,11 @@ module Google
2580
2721
  attr_accessor :change_type
2581
2722
 
2582
2723
  # Cloud Firestore indexes enable simple and complex queries against documents in
2583
- # a database.
2724
+ # a database. In Standard edition databases, single-field indexes are managed
2725
+ # using the google.firestore.admin.v1.Field resource, and composite indexes are
2726
+ # managed using the google.firestore.admin.v1.Index resource. In Enterprise
2727
+ # edition databases, both single-field and composite indexes are managed using
2728
+ # the google.firestore.admin.v1.Index resource.
2584
2729
  # Corresponds to the JSON property `index`
2585
2730
  # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index]
2586
2731
  attr_accessor :index
@@ -2745,6 +2890,25 @@ module Google
2745
2890
  end
2746
2891
  end
2747
2892
 
2893
+ # Response to FirestoreAdmin.ListChangeStreams.
2894
+ class GoogleFirestoreAdminV1ListChangeStreamsResponse
2895
+ include Google::Apis::Core::Hashable
2896
+
2897
+ # The list of change streams.
2898
+ # Corresponds to the JSON property `changeStreams`
2899
+ # @return [Array<Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream>]
2900
+ attr_accessor :change_streams
2901
+
2902
+ def initialize(**args)
2903
+ update!(**args)
2904
+ end
2905
+
2906
+ # Update properties of this object
2907
+ def update!(**args)
2908
+ @change_streams = args[:change_streams] if args.key?(:change_streams)
2909
+ end
2910
+ end
2911
+
2748
2912
  # The list of databases for a project.
2749
2913
  class GoogleFirestoreAdminV1ListDatabasesResponse
2750
2914
  include Google::Apis::Core::Hashable
@@ -3317,12 +3481,31 @@ module Google
3317
3481
  class GoogleFirestoreAdminV1UpdateDatabaseMetadata
3318
3482
  include Google::Apis::Core::Hashable
3319
3483
 
3484
+ # The time this operation completed. Will be unset if operation still in
3485
+ # progress.
3486
+ # Corresponds to the JSON property `endTime`
3487
+ # @return [String]
3488
+ attr_accessor :end_time
3489
+
3490
+ # The time this operation started.
3491
+ # Corresponds to the JSON property `startTime`
3492
+ # @return [String]
3493
+ attr_accessor :start_time
3494
+
3495
+ # The state of the operation.
3496
+ # Corresponds to the JSON property `state`
3497
+ # @return [String]
3498
+ attr_accessor :state
3499
+
3320
3500
  def initialize(**args)
3321
3501
  update!(**args)
3322
3502
  end
3323
3503
 
3324
3504
  # Update properties of this object
3325
3505
  def update!(**args)
3506
+ @end_time = args[:end_time] if args.key?(:end_time)
3507
+ @start_time = args[:start_time] if args.key?(:start_time)
3508
+ @state = args[:state] if args.key?(:state)
3326
3509
  end
3327
3510
  end
3328
3511
 
@@ -3584,6 +3767,11 @@ module Google
3584
3767
  # @return [String]
3585
3768
  attr_accessor :read_time
3586
3769
 
3770
+ # Options for a server request.
3771
+ # Corresponds to the JSON property `requestOptions`
3772
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
3773
+ attr_accessor :request_options
3774
+
3587
3775
  def initialize(**args)
3588
3776
  update!(**args)
3589
3777
  end
@@ -3593,6 +3781,7 @@ module Google
3593
3781
  @page_size = args[:page_size] if args.key?(:page_size)
3594
3782
  @page_token = args[:page_token] if args.key?(:page_token)
3595
3783
  @read_time = args[:read_time] if args.key?(:read_time)
3784
+ @request_options = args[:request_options] if args.key?(:request_options)
3596
3785
  end
3597
3786
  end
3598
3787
 
@@ -3691,6 +3880,11 @@ module Google
3691
3880
  # @return [Fixnum]
3692
3881
  attr_accessor :remove_target
3693
3882
 
3883
+ # Options for a server request.
3884
+ # Corresponds to the JSON property `requestOptions`
3885
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
3886
+ attr_accessor :request_options
3887
+
3694
3888
  def initialize(**args)
3695
3889
  update!(**args)
3696
3890
  end
@@ -3700,6 +3894,7 @@ module Google
3700
3894
  @add_target = args[:add_target] if args.key?(:add_target)
3701
3895
  @labels = args[:labels] if args.key?(:labels)
3702
3896
  @remove_target = args[:remove_target] if args.key?(:remove_target)
3897
+ @request_options = args[:request_options] if args.key?(:request_options)
3703
3898
  end
3704
3899
  end
3705
3900
 
@@ -3893,6 +4088,11 @@ module Google
3893
4088
  # @return [String]
3894
4089
  attr_accessor :read_time
3895
4090
 
4091
+ # Options for a server request.
4092
+ # Corresponds to the JSON property `requestOptions`
4093
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
4094
+ attr_accessor :request_options
4095
+
3896
4096
  # A Firestore query. The query stages are executed in the following order: 1.
3897
4097
  # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
3898
4098
  # find_nearest
@@ -3910,6 +4110,7 @@ module Google
3910
4110
  @page_token = args[:page_token] if args.key?(:page_token)
3911
4111
  @partition_count = args[:partition_count] if args.key?(:partition_count)
3912
4112
  @read_time = args[:read_time] if args.key?(:read_time)
4113
+ @request_options = args[:request_options] if args.key?(:request_options)
3913
4114
  @structured_query = args[:structured_query] if args.key?(:structured_query)
3914
4115
  end
3915
4116
  end
@@ -4120,10 +4321,34 @@ module Google
4120
4321
  end
4121
4322
  end
4122
4323
 
4324
+ # Options for a server request.
4325
+ class RequestOptions
4326
+ include Google::Apis::Core::Hashable
4327
+
4328
+ # Optional. The request tags for the request.
4329
+ # Corresponds to the JSON property `requestTags`
4330
+ # @return [Array<String>]
4331
+ attr_accessor :request_tags
4332
+
4333
+ def initialize(**args)
4334
+ update!(**args)
4335
+ end
4336
+
4337
+ # Update properties of this object
4338
+ def update!(**args)
4339
+ @request_tags = args[:request_tags] if args.key?(:request_tags)
4340
+ end
4341
+ end
4342
+
4123
4343
  # The request for Firestore.Rollback.
4124
4344
  class RollbackRequest
4125
4345
  include Google::Apis::Core::Hashable
4126
4346
 
4347
+ # Options for a server request.
4348
+ # Corresponds to the JSON property `requestOptions`
4349
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
4350
+ attr_accessor :request_options
4351
+
4127
4352
  # Required. The transaction to roll back.
4128
4353
  # Corresponds to the JSON property `transaction`
4129
4354
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
@@ -4136,6 +4361,7 @@ module Google
4136
4361
 
4137
4362
  # Update properties of this object
4138
4363
  def update!(**args)
4364
+ @request_options = args[:request_options] if args.key?(:request_options)
4139
4365
  @transaction = args[:transaction] if args.key?(:transaction)
4140
4366
  end
4141
4367
  end
@@ -4161,6 +4387,11 @@ module Google
4161
4387
  # @return [String]
4162
4388
  attr_accessor :read_time
4163
4389
 
4390
+ # Options for a server request.
4391
+ # Corresponds to the JSON property `requestOptions`
4392
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
4393
+ attr_accessor :request_options
4394
+
4164
4395
  # Firestore query for running an aggregation over a StructuredQuery.
4165
4396
  # Corresponds to the JSON property `structuredAggregationQuery`
4166
4397
  # @return [Google::Apis::FirestoreV1::StructuredAggregationQuery]
@@ -4182,6 +4413,7 @@ module Google
4182
4413
  @explain_options = args[:explain_options] if args.key?(:explain_options)
4183
4414
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
4184
4415
  @read_time = args[:read_time] if args.key?(:read_time)
4416
+ @request_options = args[:request_options] if args.key?(:request_options)
4185
4417
  @structured_aggregation_query = args[:structured_aggregation_query] if args.key?(:structured_aggregation_query)
4186
4418
  @transaction = args[:transaction] if args.key?(:transaction)
4187
4419
  end
@@ -4253,6 +4485,11 @@ module Google
4253
4485
  # @return [String]
4254
4486
  attr_accessor :read_time
4255
4487
 
4488
+ # Options for a server request.
4489
+ # Corresponds to the JSON property `requestOptions`
4490
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
4491
+ attr_accessor :request_options
4492
+
4256
4493
  # A Firestore query. The query stages are executed in the following order: 1.
4257
4494
  # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
4258
4495
  # find_nearest
@@ -4276,6 +4513,7 @@ module Google
4276
4513
  @explain_options = args[:explain_options] if args.key?(:explain_options)
4277
4514
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
4278
4515
  @read_time = args[:read_time] if args.key?(:read_time)
4516
+ @request_options = args[:request_options] if args.key?(:request_options)
4279
4517
  @structured_query = args[:structured_query] if args.key?(:structured_query)
4280
4518
  @transaction = args[:transaction] if args.key?(:transaction)
4281
4519
  end
@@ -4793,8 +5031,10 @@ module Google
4793
5031
  attr_accessor :boolean_value
4794
5032
  alias_method :boolean_value?, :boolean_value
4795
5033
 
4796
- # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes
4797
- # are considered by queries.
5034
+ # A bytes value. In Standard edition databases: * The value must not exceed 1
5035
+ # MiB - 89 bytes. * Only the first 1,500 bytes are considered by queries. In
5036
+ # Enterprise edition databases, there is no limit on the size of the value.
5037
+ # However, it is still subject to document and index entry size limits.
4798
5038
  # Corresponds to the JSON property `bytesValue`
4799
5039
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
4800
5040
  # @return [String]
@@ -4854,9 +5094,11 @@ module Google
4854
5094
  # @return [String]
4855
5095
  attr_accessor :reference_value
4856
5096
 
4857
- # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89
4858
- # bytes. Only the first 1,500 bytes of the UTF-8 representation are considered
4859
- # by queries.
5097
+ # A string value. In Standard edition databases: * The string, represented as
5098
+ # UTF-8, must not exceed 1 MiB - 89 bytes. * Only the first 1,500 bytes of the
5099
+ # UTF-8 representation are considered by queries. In Enterprise edition
5100
+ # databases, there is no limit on the size of the value. However, it is still
5101
+ # subject to document and index entry size limits.
4860
5102
  # Corresponds to the JSON property `stringValue`
4861
5103
  # @return [String]
4862
5104
  attr_accessor :string_value
@@ -4967,6 +5209,11 @@ module Google
4967
5209
  # @return [Hash<String,String>]
4968
5210
  attr_accessor :labels
4969
5211
 
5212
+ # Options for a server request.
5213
+ # Corresponds to the JSON property `requestOptions`
5214
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
5215
+ attr_accessor :request_options
5216
+
4970
5217
  # The ID of the write stream to resume. This may only be set in the first
4971
5218
  # message. When left empty, a new write stream will be created.
4972
5219
  # Corresponds to the JSON property `streamId`
@@ -5000,6 +5247,7 @@ module Google
5000
5247
  # Update properties of this object
5001
5248
  def update!(**args)
5002
5249
  @labels = args[:labels] if args.key?(:labels)
5250
+ @request_options = args[:request_options] if args.key?(:request_options)
5003
5251
  @stream_id = args[:stream_id] if args.key?(:stream_id)
5004
5252
  @stream_token = args[:stream_token] if args.key?(:stream_token)
5005
5253
  @writes = args[:writes] if args.key?(:writes)
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module FirestoreV1
18
18
  # Version of the google-apis-firestore_v1 gem
19
- GEM_VERSION = "0.96.0"
19
+ GEM_VERSION = "0.98.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 = "20260608"
25
+ REVISION = "20260810"
26
26
  end
27
27
  end
28
28
  end
@@ -286,6 +286,12 @@ module Google
286
286
  include Google::Apis::Core::JsonObjectSupport
287
287
  end
288
288
 
289
+ class GoogleFirestoreAdminV1ChangeStream
290
+ class Representation < Google::Apis::Core::JsonRepresentation; end
291
+
292
+ include Google::Apis::Core::JsonObjectSupport
293
+ end
294
+
289
295
  class GoogleFirestoreAdminV1CloneDatabaseMetadata
290
296
  class Representation < Google::Apis::Core::JsonRepresentation; end
291
297
 
@@ -304,6 +310,12 @@ module Google
304
310
  include Google::Apis::Core::JsonObjectSupport
305
311
  end
306
312
 
313
+ class GoogleFirestoreAdminV1CollectionGroupScope
314
+ class Representation < Google::Apis::Core::JsonRepresentation; end
315
+
316
+ include Google::Apis::Core::JsonObjectSupport
317
+ end
318
+
307
319
  class GoogleFirestoreAdminV1CreateDatabaseMetadata
308
320
  class Representation < Google::Apis::Core::JsonRepresentation; end
309
321
 
@@ -328,6 +340,12 @@ module Google
328
340
  include Google::Apis::Core::JsonObjectSupport
329
341
  end
330
342
 
343
+ class GoogleFirestoreAdminV1DatabaseScope
344
+ class Representation < Google::Apis::Core::JsonRepresentation; end
345
+
346
+ include Google::Apis::Core::JsonObjectSupport
347
+ end
348
+
331
349
  class GoogleFirestoreAdminV1DeleteDatabaseMetadata
332
350
  class Representation < Google::Apis::Core::JsonRepresentation; end
333
351
 
@@ -448,6 +466,12 @@ module Google
448
466
  include Google::Apis::Core::JsonObjectSupport
449
467
  end
450
468
 
469
+ class GoogleFirestoreAdminV1ListChangeStreamsResponse
470
+ class Representation < Google::Apis::Core::JsonRepresentation; end
471
+
472
+ include Google::Apis::Core::JsonObjectSupport
473
+ end
474
+
451
475
  class GoogleFirestoreAdminV1ListDatabasesResponse
452
476
  class Representation < Google::Apis::Core::JsonRepresentation; end
453
477
 
@@ -730,6 +754,12 @@ module Google
730
754
  include Google::Apis::Core::JsonObjectSupport
731
755
  end
732
756
 
757
+ class RequestOptions
758
+ class Representation < Google::Apis::Core::JsonRepresentation; end
759
+
760
+ include Google::Apis::Core::JsonObjectSupport
761
+ end
762
+
733
763
  class RollbackRequest
734
764
  class Representation < Google::Apis::Core::JsonRepresentation; end
735
765
 
@@ -896,6 +926,8 @@ module Google
896
926
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
897
927
 
898
928
  property :read_time, as: 'readTime'
929
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
930
+
899
931
  property :transaction, :base64 => true, as: 'transaction'
900
932
  end
901
933
  end
@@ -915,6 +947,8 @@ module Google
915
947
  # @private
916
948
  class Representation < Google::Apis::Core::JsonRepresentation
917
949
  hash :labels, as: 'labels'
950
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
951
+
918
952
  collection :writes, as: 'writes', class: Google::Apis::FirestoreV1::Write, decorator: Google::Apis::FirestoreV1::Write::Representation
919
953
 
920
954
  end
@@ -935,6 +969,8 @@ module Google
935
969
  class Representation < Google::Apis::Core::JsonRepresentation
936
970
  property :options, as: 'options', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
937
971
 
972
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
973
+
938
974
  end
939
975
  end
940
976
 
@@ -973,6 +1009,8 @@ module Google
973
1009
  class CommitRequest
974
1010
  # @private
975
1011
  class Representation < Google::Apis::Core::JsonRepresentation
1012
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1013
+
976
1014
  property :transaction, :base64 => true, as: 'transaction'
977
1015
  collection :writes, as: 'writes', class: Google::Apis::FirestoreV1::Write, decorator: Google::Apis::FirestoreV1::Write::Representation
978
1016
 
@@ -1088,6 +1126,8 @@ module Google
1088
1126
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
1089
1127
 
1090
1128
  property :read_time, as: 'readTime'
1129
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1130
+
1091
1131
  property :structured_pipeline, as: 'structuredPipeline', class: Google::Apis::FirestoreV1::StructuredPipeline, decorator: Google::Apis::FirestoreV1::StructuredPipeline::Representation
1092
1132
 
1093
1133
  property :transaction, :base64 => true, as: 'transaction'
@@ -1282,6 +1322,22 @@ module Google
1282
1322
  end
1283
1323
  end
1284
1324
 
1325
+ class GoogleFirestoreAdminV1ChangeStream
1326
+ # @private
1327
+ class Representation < Google::Apis::Core::JsonRepresentation
1328
+ property :collection_group_scope, as: 'collectionGroupScope', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CollectionGroupScope, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CollectionGroupScope::Representation
1329
+
1330
+ property :create_time, as: 'createTime'
1331
+ property :database_scope, as: 'databaseScope', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseScope, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1DatabaseScope::Representation
1332
+
1333
+ property :etag, as: 'etag'
1334
+ property :name, as: 'name'
1335
+ property :retention_period, as: 'retentionPeriod'
1336
+ property :start_time, as: 'startTime'
1337
+ property :update_time, as: 'updateTime'
1338
+ end
1339
+ end
1340
+
1285
1341
  class GoogleFirestoreAdminV1CloneDatabaseMetadata
1286
1342
  # @private
1287
1343
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1316,6 +1372,13 @@ module Google
1316
1372
  end
1317
1373
  end
1318
1374
 
1375
+ class GoogleFirestoreAdminV1CollectionGroupScope
1376
+ # @private
1377
+ class Representation < Google::Apis::Core::JsonRepresentation
1378
+ property :collection_group_id, as: 'collectionGroupId'
1379
+ end
1380
+ end
1381
+
1319
1382
  class GoogleFirestoreAdminV1CreateDatabaseMetadata
1320
1383
  # @private
1321
1384
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1367,6 +1430,12 @@ module Google
1367
1430
  end
1368
1431
  end
1369
1432
 
1433
+ class GoogleFirestoreAdminV1DatabaseScope
1434
+ # @private
1435
+ class Representation < Google::Apis::Core::JsonRepresentation
1436
+ end
1437
+ end
1438
+
1370
1439
  class GoogleFirestoreAdminV1DeleteDatabaseMetadata
1371
1440
  # @private
1372
1441
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1579,6 +1648,14 @@ module Google
1579
1648
  end
1580
1649
  end
1581
1650
 
1651
+ class GoogleFirestoreAdminV1ListChangeStreamsResponse
1652
+ # @private
1653
+ class Representation < Google::Apis::Core::JsonRepresentation
1654
+ collection :change_streams, as: 'changeStreams', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
1655
+
1656
+ end
1657
+ end
1658
+
1582
1659
  class GoogleFirestoreAdminV1ListDatabasesResponse
1583
1660
  # @private
1584
1661
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1758,6 +1835,9 @@ module Google
1758
1835
  class GoogleFirestoreAdminV1UpdateDatabaseMetadata
1759
1836
  # @private
1760
1837
  class Representation < Google::Apis::Core::JsonRepresentation
1838
+ property :end_time, as: 'endTime'
1839
+ property :start_time, as: 'startTime'
1840
+ property :state, as: 'state'
1761
1841
  end
1762
1842
  end
1763
1843
 
@@ -1832,6 +1912,8 @@ module Google
1832
1912
  property :page_size, as: 'pageSize'
1833
1913
  property :page_token, as: 'pageToken'
1834
1914
  property :read_time, as: 'readTime'
1915
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1916
+
1835
1917
  end
1836
1918
  end
1837
1919
 
@@ -1868,6 +1950,8 @@ module Google
1868
1950
 
1869
1951
  hash :labels, as: 'labels'
1870
1952
  property :remove_target, as: 'removeTarget'
1953
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1954
+
1871
1955
  end
1872
1956
  end
1873
1957
 
@@ -1922,6 +2006,8 @@ module Google
1922
2006
  property :page_token, as: 'pageToken'
1923
2007
  property :partition_count, :numeric_string => true, as: 'partitionCount'
1924
2008
  property :read_time, as: 'readTime'
2009
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2010
+
1925
2011
  property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1::StructuredQuery, decorator: Google::Apis::FirestoreV1::StructuredQuery::Representation
1926
2012
 
1927
2013
  end
@@ -1991,9 +2077,18 @@ module Google
1991
2077
  end
1992
2078
  end
1993
2079
 
2080
+ class RequestOptions
2081
+ # @private
2082
+ class Representation < Google::Apis::Core::JsonRepresentation
2083
+ collection :request_tags, as: 'requestTags'
2084
+ end
2085
+ end
2086
+
1994
2087
  class RollbackRequest
1995
2088
  # @private
1996
2089
  class Representation < Google::Apis::Core::JsonRepresentation
2090
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2091
+
1997
2092
  property :transaction, :base64 => true, as: 'transaction'
1998
2093
  end
1999
2094
  end
@@ -2006,6 +2101,8 @@ module Google
2006
2101
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
2007
2102
 
2008
2103
  property :read_time, as: 'readTime'
2104
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2105
+
2009
2106
  property :structured_aggregation_query, as: 'structuredAggregationQuery', class: Google::Apis::FirestoreV1::StructuredAggregationQuery, decorator: Google::Apis::FirestoreV1::StructuredAggregationQuery::Representation
2010
2107
 
2011
2108
  property :transaction, :base64 => true, as: 'transaction'
@@ -2032,6 +2129,8 @@ module Google
2032
2129
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
2033
2130
 
2034
2131
  property :read_time, as: 'readTime'
2132
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2133
+
2035
2134
  property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1::StructuredQuery, decorator: Google::Apis::FirestoreV1::StructuredQuery::Representation
2036
2135
 
2037
2136
  property :transaction, :base64 => true, as: 'transaction'
@@ -2215,6 +2314,8 @@ module Google
2215
2314
  # @private
2216
2315
  class Representation < Google::Apis::Core::JsonRepresentation
2217
2316
  hash :labels, as: 'labels'
2317
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2318
+
2218
2319
  property :stream_id, as: 'streamId'
2219
2320
  property :stream_token, :base64 => true, as: 'streamToken'
2220
2321
  collection :writes, as: 'writes', class: Google::Apis::FirestoreV1::Write, decorator: Google::Apis::FirestoreV1::Write::Representation
@@ -597,6 +597,144 @@ module Google
597
597
  execute_or_queue_command(command, &block)
598
598
  end
599
599
 
600
+ # Creates a new change stream for the database.
601
+ # @param [String] parent
602
+ # Required. The parent database to create the change stream for. Format is `
603
+ # projects/`project`/databases/`database``.
604
+ # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream] google_firestore_admin_v1_change_stream_object
605
+ # @param [String] change_stream_id
606
+ # Required. The ID to use for the change stream, which will become the final
607
+ # component of the change stream's resource name. This value should be 4-63
608
+ # characters. Valid characters are lowercase letters, numbers, and hyphens. The
609
+ # first character must be a letter, and the last character must be a letter or a
610
+ # number.
611
+ # @param [String] fields
612
+ # Selector specifying which fields to include in a partial response.
613
+ # @param [String] quota_user
614
+ # Available to use for quota purposes for server-side applications. Can be any
615
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
616
+ # @param [Google::Apis::RequestOptions] options
617
+ # Request-specific options
618
+ #
619
+ # @yield [result, err] Result & error if block supplied
620
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream] parsed result object
621
+ # @yieldparam err [StandardError] error object if request failed
622
+ #
623
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream]
624
+ #
625
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
626
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
627
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
628
+ def create_project_database_change_stream(parent, google_firestore_admin_v1_change_stream_object = nil, change_stream_id: nil, fields: nil, quota_user: nil, options: nil, &block)
629
+ command = make_simple_command(:post, 'v1/{+parent}/changeStreams', options)
630
+ command.request_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
631
+ command.request_object = google_firestore_admin_v1_change_stream_object
632
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
633
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
634
+ command.params['parent'] = parent unless parent.nil?
635
+ command.query['changeStreamId'] = change_stream_id unless change_stream_id.nil?
636
+ command.query['fields'] = fields unless fields.nil?
637
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
638
+ execute_or_queue_command(command, &block)
639
+ end
640
+
641
+ # Deletes a change stream.
642
+ # @param [String] name
643
+ # Required. The name of the change stream to delete. Format is `projects/`
644
+ # project`/databases/`database`/changeStreams/`change_stream``.
645
+ # @param [String] etag
646
+ # Optional. The etag of the change stream to delete. If this is not the current
647
+ # etag of the change stream, the deletion will fail.
648
+ # @param [String] fields
649
+ # Selector specifying which fields to include in a partial response.
650
+ # @param [String] quota_user
651
+ # Available to use for quota purposes for server-side applications. Can be any
652
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
653
+ # @param [Google::Apis::RequestOptions] options
654
+ # Request-specific options
655
+ #
656
+ # @yield [result, err] Result & error if block supplied
657
+ # @yieldparam result [Google::Apis::FirestoreV1::Empty] parsed result object
658
+ # @yieldparam err [StandardError] error object if request failed
659
+ #
660
+ # @return [Google::Apis::FirestoreV1::Empty]
661
+ #
662
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
663
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
664
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
665
+ def delete_project_database_change_stream(name, etag: nil, fields: nil, quota_user: nil, options: nil, &block)
666
+ command = make_simple_command(:delete, 'v1/{+name}', options)
667
+ command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
668
+ command.response_class = Google::Apis::FirestoreV1::Empty
669
+ command.params['name'] = name unless name.nil?
670
+ command.query['etag'] = etag unless etag.nil?
671
+ command.query['fields'] = fields unless fields.nil?
672
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
673
+ execute_or_queue_command(command, &block)
674
+ end
675
+
676
+ # Gets information about a change stream.
677
+ # @param [String] name
678
+ # Required. The name of the change stream to retrieve. Format is `projects/`
679
+ # project`/databases/`database`/changeStreams/`change_stream``.
680
+ # @param [String] fields
681
+ # Selector specifying which fields to include in a partial response.
682
+ # @param [String] quota_user
683
+ # Available to use for quota purposes for server-side applications. Can be any
684
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
685
+ # @param [Google::Apis::RequestOptions] options
686
+ # Request-specific options
687
+ #
688
+ # @yield [result, err] Result & error if block supplied
689
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream] parsed result object
690
+ # @yieldparam err [StandardError] error object if request failed
691
+ #
692
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream]
693
+ #
694
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
695
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
696
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
697
+ def get_project_database_change_stream(name, fields: nil, quota_user: nil, options: nil, &block)
698
+ command = make_simple_command(:get, 'v1/{+name}', options)
699
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream::Representation
700
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ChangeStream
701
+ command.params['name'] = name unless name.nil?
702
+ command.query['fields'] = fields unless fields.nil?
703
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
704
+ execute_or_queue_command(command, &block)
705
+ end
706
+
707
+ # Lists all change streams in a database.
708
+ # @param [String] parent
709
+ # Required. The parent database to list change streams from. Format is `projects/
710
+ # `project`/databases/`database``.
711
+ # @param [String] fields
712
+ # Selector specifying which fields to include in a partial response.
713
+ # @param [String] quota_user
714
+ # Available to use for quota purposes for server-side applications. Can be any
715
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
716
+ # @param [Google::Apis::RequestOptions] options
717
+ # Request-specific options
718
+ #
719
+ # @yield [result, err] Result & error if block supplied
720
+ # @yieldparam result [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse] parsed result object
721
+ # @yieldparam err [StandardError] error object if request failed
722
+ #
723
+ # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse]
724
+ #
725
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
726
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
727
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
728
+ def list_project_database_change_streams(parent, fields: nil, quota_user: nil, options: nil, &block)
729
+ command = make_simple_command(:get, 'v1/{+parent}/changeStreams', options)
730
+ command.response_representation = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse::Representation
731
+ command.response_class = Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ListChangeStreamsResponse
732
+ command.params['parent'] = parent unless parent.nil?
733
+ command.query['fields'] = fields unless fields.nil?
734
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
735
+ execute_or_queue_command(command, &block)
736
+ end
737
+
600
738
  # Gets the metadata and configuration for a Field.
601
739
  # @param [String] name
602
740
  # Required. A name of the form `projects/`project_id`/databases/`database_id`/
@@ -1029,6 +1167,8 @@ module Google
1029
1167
  # @param [Array<String>, String] mask_field_paths
1030
1168
  # The list of field paths in the mask. See Document.fields for a field path
1031
1169
  # syntax reference.
1170
+ # @param [Array<String>, String] request_options_request_tags
1171
+ # Optional. The request tags for the request.
1032
1172
  # @param [String] fields
1033
1173
  # Selector specifying which fields to include in a partial response.
1034
1174
  # @param [String] quota_user
@@ -1046,7 +1186,7 @@ module Google
1046
1186
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1047
1187
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1048
1188
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1049
- 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)
1189
+ 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)
1050
1190
  command = make_simple_command(:post, 'v1/{+parent}/{collectionId}', options)
1051
1191
  command.request_representation = Google::Apis::FirestoreV1::Document::Representation
1052
1192
  command.request_object = document_object
@@ -1056,6 +1196,7 @@ module Google
1056
1196
  command.params['collectionId'] = collection_id unless collection_id.nil?
1057
1197
  command.query['documentId'] = document_id unless document_id.nil?
1058
1198
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
1199
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1059
1200
  command.query['fields'] = fields unless fields.nil?
1060
1201
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1061
1202
  execute_or_queue_command(command, &block)
@@ -1071,6 +1212,8 @@ module Google
1071
1212
  # @param [String] current_document_update_time
1072
1213
  # When set, the target document must exist and have been last updated at that
1073
1214
  # time. Timestamp must be microsecond aligned.
1215
+ # @param [Array<String>, String] request_options_request_tags
1216
+ # Optional. The request tags for the request.
1074
1217
  # @param [String] fields
1075
1218
  # Selector specifying which fields to include in a partial response.
1076
1219
  # @param [String] quota_user
@@ -1088,13 +1231,14 @@ module Google
1088
1231
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1089
1232
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1090
1233
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1091
- def delete_project_database_document(name, current_document_exists: nil, current_document_update_time: nil, fields: nil, quota_user: nil, options: nil, &block)
1234
+ 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)
1092
1235
  command = make_simple_command(:delete, 'v1/{+name}', options)
1093
1236
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
1094
1237
  command.response_class = Google::Apis::FirestoreV1::Empty
1095
1238
  command.params['name'] = name unless name.nil?
1096
1239
  command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
1097
1240
  command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
1241
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1098
1242
  command.query['fields'] = fields unless fields.nil?
1099
1243
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1100
1244
  execute_or_queue_command(command, &block)
@@ -1146,6 +1290,8 @@ module Google
1146
1290
  # microsecond precision timestamp within the past one hour, or if Point-in-Time
1147
1291
  # Recovery is enabled, can additionally be a whole minute timestamp within the
1148
1292
  # past 7 days.
1293
+ # @param [Array<String>, String] request_options_request_tags
1294
+ # Optional. The request tags for the request.
1149
1295
  # @param [String] transaction
1150
1296
  # Reads the document in a transaction.
1151
1297
  # @param [String] fields
@@ -1165,13 +1311,14 @@ module Google
1165
1311
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1166
1312
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1167
1313
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1168
- def get_project_database_document(name, mask_field_paths: nil, read_time: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
1314
+ 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)
1169
1315
  command = make_simple_command(:get, 'v1/{+name}', options)
1170
1316
  command.response_representation = Google::Apis::FirestoreV1::Document::Representation
1171
1317
  command.response_class = Google::Apis::FirestoreV1::Document
1172
1318
  command.params['name'] = name unless name.nil?
1173
1319
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
1174
1320
  command.query['readTime'] = read_time unless read_time.nil?
1321
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1175
1322
  command.query['transaction'] = transaction unless transaction.nil?
1176
1323
  command.query['fields'] = fields unless fields.nil?
1177
1324
  command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -1209,6 +1356,15 @@ module Google
1209
1356
  # Perform the read at the provided time. This must be a microsecond precision
1210
1357
  # timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
1211
1358
  # can additionally be a whole minute timestamp within the past 7 days.
1359
+ # @param [Boolean] recursive
1360
+ # Optional. If the list should recursively include all documents nested under
1361
+ # the parent at any level. If the request specifies a `collection_id`, then the
1362
+ # list will include all nested documents in the collection under the parent.
1363
+ # This is optional, and when not provided, Firestore will only list documents
1364
+ # nested immediately under the parent. Requests with `recursive` may not specify
1365
+ # `show_missing`.
1366
+ # @param [Array<String>, String] request_options_request_tags
1367
+ # Optional. The request tags for the request.
1212
1368
  # @param [Boolean] show_missing
1213
1369
  # If the list should show missing documents. A document is missing if it does
1214
1370
  # not exist, but there are sub-documents nested underneath it. When true, such
@@ -1234,7 +1390,7 @@ module Google
1234
1390
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1235
1391
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1236
1392
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1237
- 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)
1393
+ 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)
1238
1394
  command = make_simple_command(:get, 'v1/{+parent}/{collectionId}', options)
1239
1395
  command.response_representation = Google::Apis::FirestoreV1::ListDocumentsResponse::Representation
1240
1396
  command.response_class = Google::Apis::FirestoreV1::ListDocumentsResponse
@@ -1245,6 +1401,8 @@ module Google
1245
1401
  command.query['pageSize'] = page_size unless page_size.nil?
1246
1402
  command.query['pageToken'] = page_token unless page_token.nil?
1247
1403
  command.query['readTime'] = read_time unless read_time.nil?
1404
+ command.query['recursive'] = recursive unless recursive.nil?
1405
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1248
1406
  command.query['showMissing'] = show_missing unless show_missing.nil?
1249
1407
  command.query['transaction'] = transaction unless transaction.nil?
1250
1408
  command.query['fields'] = fields unless fields.nil?
@@ -1319,6 +1477,15 @@ module Google
1319
1477
  # Perform the read at the provided time. This must be a microsecond precision
1320
1478
  # timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
1321
1479
  # can additionally be a whole minute timestamp within the past 7 days.
1480
+ # @param [Boolean] recursive
1481
+ # Optional. If the list should recursively include all documents nested under
1482
+ # the parent at any level. If the request specifies a `collection_id`, then the
1483
+ # list will include all nested documents in the collection under the parent.
1484
+ # This is optional, and when not provided, Firestore will only list documents
1485
+ # nested immediately under the parent. Requests with `recursive` may not specify
1486
+ # `show_missing`.
1487
+ # @param [Array<String>, String] request_options_request_tags
1488
+ # Optional. The request tags for the request.
1322
1489
  # @param [Boolean] show_missing
1323
1490
  # If the list should show missing documents. A document is missing if it does
1324
1491
  # not exist, but there are sub-documents nested underneath it. When true, such
@@ -1344,7 +1511,7 @@ module Google
1344
1511
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1345
1512
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1346
1513
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1347
- 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)
1514
+ 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)
1348
1515
  command = make_simple_command(:get, 'v1/{+parent}/{collectionId}', options)
1349
1516
  command.response_representation = Google::Apis::FirestoreV1::ListDocumentsResponse::Representation
1350
1517
  command.response_class = Google::Apis::FirestoreV1::ListDocumentsResponse
@@ -1355,6 +1522,8 @@ module Google
1355
1522
  command.query['pageSize'] = page_size unless page_size.nil?
1356
1523
  command.query['pageToken'] = page_token unless page_token.nil?
1357
1524
  command.query['readTime'] = read_time unless read_time.nil?
1525
+ command.query['recursive'] = recursive unless recursive.nil?
1526
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1358
1527
  command.query['showMissing'] = show_missing unless show_missing.nil?
1359
1528
  command.query['transaction'] = transaction unless transaction.nil?
1360
1529
  command.query['fields'] = fields unless fields.nil?
@@ -1448,6 +1617,8 @@ module Google
1448
1617
  # @param [Array<String>, String] mask_field_paths
1449
1618
  # The list of field paths in the mask. See Document.fields for a field path
1450
1619
  # syntax reference.
1620
+ # @param [Array<String>, String] request_options_request_tags
1621
+ # Optional. The request tags for the request.
1451
1622
  # @param [Array<String>, String] update_mask_field_paths
1452
1623
  # The list of field paths in the mask. See Document.fields for a field path
1453
1624
  # syntax reference.
@@ -1468,7 +1639,7 @@ module Google
1468
1639
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1469
1640
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1470
1641
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1471
- 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)
1642
+ 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)
1472
1643
  command = make_simple_command(:patch, 'v1/{+name}', options)
1473
1644
  command.request_representation = Google::Apis::FirestoreV1::Document::Representation
1474
1645
  command.request_object = document_object
@@ -1478,6 +1649,7 @@ module Google
1478
1649
  command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
1479
1650
  command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
1480
1651
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
1652
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1481
1653
  command.query['updateMask.fieldPaths'] = update_mask_field_paths unless update_mask_field_paths.nil?
1482
1654
  command.query['fields'] = fields unless fields.nil?
1483
1655
  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_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.96.0
4
+ version: 0.98.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_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.96.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.98.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
62
62
  rdoc_options: []
63
63
  require_paths: