google-apis-firestore_v1 0.95.0 → 0.97.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: f519f3747b453aa5447933eec60dfe09ec890bca2dda610daf3c80b00ff96476
4
- data.tar.gz: 03a8809efdc3894310019438c2f283590bb14c24ed4788c6679304d9f2da58fa
3
+ metadata.gz: 87c60e3b964055a23a408ab38df4afbc480efa42f5257ffca479d6b81182cc18
4
+ data.tar.gz: fcbc4e193746d2888768c34de3587a4a4fc75d9d062e3501136a8f472fbce029
5
5
  SHA512:
6
- metadata.gz: 38bd79ce45f26b29adf65aec2a98bc6d6a781dc351892a9a8d0e7c7d380dcf943e25669e372ae3188a4060b00aba422c2c19288994540807189a26c0cee7c4f7
7
- data.tar.gz: a82654d302cab79a02160f1c1fd9aa896c7f970523a2df0b5b6695442655d53abab8bc6333ac3008d67b1008aa5d8e16291f8139a70aa550e836ad4085034d2a
6
+ metadata.gz: de8873e7253ca195b03caa9dd2a57e1d05397bd1180ba6b2362831744604735c7d63b2d77159caa161915dce603fb1bf1460b4a3f2e2a2650781f6a054c40ec0
7
+ data.tar.gz: 8c9e1cd7b42b51a4c397112d40cc10d19f0aa4976889e1f1b406ebfe669002cc8379486f2cc865c74aa6a9940a612fd130a54e2eb0937f6c8133e72d14f57318
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Release history for google-apis-firestore_v1
2
2
 
3
+ ### v0.97.0 (2026-07-12)
4
+
5
+ * Regenerated from discovery document revision 20260702
6
+
7
+ ### v0.96.0 (2026-06-21)
8
+
9
+ * Regenerated from discovery document revision 20260608
10
+
3
11
  ### v0.95.0 (2026-06-14)
4
12
 
5
13
  * Regenerated from discovery document revision 20260529
@@ -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
@@ -830,6 +854,14 @@ module Google
830
854
  class ExecutePipelineRequest
831
855
  include Google::Apis::Core::Hashable
832
856
 
857
+ # Optional. Automatically commits the transaction after the pipeline has been
858
+ # executed. Only permitted in combination with `transaction` or `new_transaction`
859
+ # .
860
+ # Corresponds to the JSON property `autoCommitTransaction`
861
+ # @return [Boolean]
862
+ attr_accessor :auto_commit_transaction
863
+ alias_method :auto_commit_transaction?, :auto_commit_transaction
864
+
833
865
  # Options for creating a new transaction.
834
866
  # Corresponds to the JSON property `newTransaction`
835
867
  # @return [Google::Apis::FirestoreV1::TransactionOptions]
@@ -843,6 +875,11 @@ module Google
843
875
  # @return [String]
844
876
  attr_accessor :read_time
845
877
 
878
+ # Options for a server request.
879
+ # Corresponds to the JSON property `requestOptions`
880
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
881
+ attr_accessor :request_options
882
+
846
883
  # A Firestore query represented as an ordered list of operations / stages. This
847
884
  # is considered the top-level function which plans and executes a query. It is
848
885
  # logically equivalent to `query(stages, options)`, but prevents the client from
@@ -864,8 +901,10 @@ module Google
864
901
 
865
902
  # Update properties of this object
866
903
  def update!(**args)
904
+ @auto_commit_transaction = args[:auto_commit_transaction] if args.key?(:auto_commit_transaction)
867
905
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
868
906
  @read_time = args[:read_time] if args.key?(:read_time)
907
+ @request_options = args[:request_options] if args.key?(:request_options)
869
908
  @structured_pipeline = args[:structured_pipeline] if args.key?(:structured_pipeline)
870
909
  @transaction = args[:transaction] if args.key?(:transaction)
871
910
  end
@@ -3575,6 +3614,11 @@ module Google
3575
3614
  # @return [String]
3576
3615
  attr_accessor :read_time
3577
3616
 
3617
+ # Options for a server request.
3618
+ # Corresponds to the JSON property `requestOptions`
3619
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
3620
+ attr_accessor :request_options
3621
+
3578
3622
  def initialize(**args)
3579
3623
  update!(**args)
3580
3624
  end
@@ -3584,6 +3628,7 @@ module Google
3584
3628
  @page_size = args[:page_size] if args.key?(:page_size)
3585
3629
  @page_token = args[:page_token] if args.key?(:page_token)
3586
3630
  @read_time = args[:read_time] if args.key?(:read_time)
3631
+ @request_options = args[:request_options] if args.key?(:request_options)
3587
3632
  end
3588
3633
  end
3589
3634
 
@@ -3682,6 +3727,11 @@ module Google
3682
3727
  # @return [Fixnum]
3683
3728
  attr_accessor :remove_target
3684
3729
 
3730
+ # Options for a server request.
3731
+ # Corresponds to the JSON property `requestOptions`
3732
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
3733
+ attr_accessor :request_options
3734
+
3685
3735
  def initialize(**args)
3686
3736
  update!(**args)
3687
3737
  end
@@ -3691,6 +3741,7 @@ module Google
3691
3741
  @add_target = args[:add_target] if args.key?(:add_target)
3692
3742
  @labels = args[:labels] if args.key?(:labels)
3693
3743
  @remove_target = args[:remove_target] if args.key?(:remove_target)
3744
+ @request_options = args[:request_options] if args.key?(:request_options)
3694
3745
  end
3695
3746
  end
3696
3747
 
@@ -3884,6 +3935,11 @@ module Google
3884
3935
  # @return [String]
3885
3936
  attr_accessor :read_time
3886
3937
 
3938
+ # Options for a server request.
3939
+ # Corresponds to the JSON property `requestOptions`
3940
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
3941
+ attr_accessor :request_options
3942
+
3887
3943
  # A Firestore query. The query stages are executed in the following order: 1.
3888
3944
  # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
3889
3945
  # find_nearest
@@ -3901,6 +3957,7 @@ module Google
3901
3957
  @page_token = args[:page_token] if args.key?(:page_token)
3902
3958
  @partition_count = args[:partition_count] if args.key?(:partition_count)
3903
3959
  @read_time = args[:read_time] if args.key?(:read_time)
3960
+ @request_options = args[:request_options] if args.key?(:request_options)
3904
3961
  @structured_query = args[:structured_query] if args.key?(:structured_query)
3905
3962
  end
3906
3963
  end
@@ -4111,10 +4168,34 @@ module Google
4111
4168
  end
4112
4169
  end
4113
4170
 
4171
+ # Options for a server request.
4172
+ class RequestOptions
4173
+ include Google::Apis::Core::Hashable
4174
+
4175
+ # Optional. The request tags for the request.
4176
+ # Corresponds to the JSON property `requestTags`
4177
+ # @return [Array<String>]
4178
+ attr_accessor :request_tags
4179
+
4180
+ def initialize(**args)
4181
+ update!(**args)
4182
+ end
4183
+
4184
+ # Update properties of this object
4185
+ def update!(**args)
4186
+ @request_tags = args[:request_tags] if args.key?(:request_tags)
4187
+ end
4188
+ end
4189
+
4114
4190
  # The request for Firestore.Rollback.
4115
4191
  class RollbackRequest
4116
4192
  include Google::Apis::Core::Hashable
4117
4193
 
4194
+ # Options for a server request.
4195
+ # Corresponds to the JSON property `requestOptions`
4196
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
4197
+ attr_accessor :request_options
4198
+
4118
4199
  # Required. The transaction to roll back.
4119
4200
  # Corresponds to the JSON property `transaction`
4120
4201
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
@@ -4127,6 +4208,7 @@ module Google
4127
4208
 
4128
4209
  # Update properties of this object
4129
4210
  def update!(**args)
4211
+ @request_options = args[:request_options] if args.key?(:request_options)
4130
4212
  @transaction = args[:transaction] if args.key?(:transaction)
4131
4213
  end
4132
4214
  end
@@ -4152,6 +4234,11 @@ module Google
4152
4234
  # @return [String]
4153
4235
  attr_accessor :read_time
4154
4236
 
4237
+ # Options for a server request.
4238
+ # Corresponds to the JSON property `requestOptions`
4239
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
4240
+ attr_accessor :request_options
4241
+
4155
4242
  # Firestore query for running an aggregation over a StructuredQuery.
4156
4243
  # Corresponds to the JSON property `structuredAggregationQuery`
4157
4244
  # @return [Google::Apis::FirestoreV1::StructuredAggregationQuery]
@@ -4173,6 +4260,7 @@ module Google
4173
4260
  @explain_options = args[:explain_options] if args.key?(:explain_options)
4174
4261
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
4175
4262
  @read_time = args[:read_time] if args.key?(:read_time)
4263
+ @request_options = args[:request_options] if args.key?(:request_options)
4176
4264
  @structured_aggregation_query = args[:structured_aggregation_query] if args.key?(:structured_aggregation_query)
4177
4265
  @transaction = args[:transaction] if args.key?(:transaction)
4178
4266
  end
@@ -4244,6 +4332,11 @@ module Google
4244
4332
  # @return [String]
4245
4333
  attr_accessor :read_time
4246
4334
 
4335
+ # Options for a server request.
4336
+ # Corresponds to the JSON property `requestOptions`
4337
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
4338
+ attr_accessor :request_options
4339
+
4247
4340
  # A Firestore query. The query stages are executed in the following order: 1.
4248
4341
  # from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7.
4249
4342
  # find_nearest
@@ -4267,6 +4360,7 @@ module Google
4267
4360
  @explain_options = args[:explain_options] if args.key?(:explain_options)
4268
4361
  @new_transaction = args[:new_transaction] if args.key?(:new_transaction)
4269
4362
  @read_time = args[:read_time] if args.key?(:read_time)
4363
+ @request_options = args[:request_options] if args.key?(:request_options)
4270
4364
  @structured_query = args[:structured_query] if args.key?(:structured_query)
4271
4365
  @transaction = args[:transaction] if args.key?(:transaction)
4272
4366
  end
@@ -4958,6 +5052,11 @@ module Google
4958
5052
  # @return [Hash<String,String>]
4959
5053
  attr_accessor :labels
4960
5054
 
5055
+ # Options for a server request.
5056
+ # Corresponds to the JSON property `requestOptions`
5057
+ # @return [Google::Apis::FirestoreV1::RequestOptions]
5058
+ attr_accessor :request_options
5059
+
4961
5060
  # The ID of the write stream to resume. This may only be set in the first
4962
5061
  # message. When left empty, a new write stream will be created.
4963
5062
  # Corresponds to the JSON property `streamId`
@@ -4991,6 +5090,7 @@ module Google
4991
5090
  # Update properties of this object
4992
5091
  def update!(**args)
4993
5092
  @labels = args[:labels] if args.key?(:labels)
5093
+ @request_options = args[:request_options] if args.key?(:request_options)
4994
5094
  @stream_id = args[:stream_id] if args.key?(:stream_id)
4995
5095
  @stream_token = args[:stream_token] if args.key?(:stream_token)
4996
5096
  @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.95.0"
19
+ GEM_VERSION = "0.97.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 = "20260529"
25
+ REVISION = "20260702"
26
26
  end
27
27
  end
28
28
  end
@@ -730,6 +730,12 @@ module Google
730
730
  include Google::Apis::Core::JsonObjectSupport
731
731
  end
732
732
 
733
+ class RequestOptions
734
+ class Representation < Google::Apis::Core::JsonRepresentation; end
735
+
736
+ include Google::Apis::Core::JsonObjectSupport
737
+ end
738
+
733
739
  class RollbackRequest
734
740
  class Representation < Google::Apis::Core::JsonRepresentation; end
735
741
 
@@ -896,6 +902,8 @@ module Google
896
902
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
897
903
 
898
904
  property :read_time, as: 'readTime'
905
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
906
+
899
907
  property :transaction, :base64 => true, as: 'transaction'
900
908
  end
901
909
  end
@@ -915,6 +923,8 @@ module Google
915
923
  # @private
916
924
  class Representation < Google::Apis::Core::JsonRepresentation
917
925
  hash :labels, as: 'labels'
926
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
927
+
918
928
  collection :writes, as: 'writes', class: Google::Apis::FirestoreV1::Write, decorator: Google::Apis::FirestoreV1::Write::Representation
919
929
 
920
930
  end
@@ -935,6 +945,8 @@ module Google
935
945
  class Representation < Google::Apis::Core::JsonRepresentation
936
946
  property :options, as: 'options', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
937
947
 
948
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
949
+
938
950
  end
939
951
  end
940
952
 
@@ -973,6 +985,8 @@ module Google
973
985
  class CommitRequest
974
986
  # @private
975
987
  class Representation < Google::Apis::Core::JsonRepresentation
988
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
989
+
976
990
  property :transaction, :base64 => true, as: 'transaction'
977
991
  collection :writes, as: 'writes', class: Google::Apis::FirestoreV1::Write, decorator: Google::Apis::FirestoreV1::Write::Representation
978
992
 
@@ -1084,9 +1098,12 @@ module Google
1084
1098
  class ExecutePipelineRequest
1085
1099
  # @private
1086
1100
  class Representation < Google::Apis::Core::JsonRepresentation
1101
+ property :auto_commit_transaction, as: 'autoCommitTransaction'
1087
1102
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
1088
1103
 
1089
1104
  property :read_time, as: 'readTime'
1105
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1106
+
1090
1107
  property :structured_pipeline, as: 'structuredPipeline', class: Google::Apis::FirestoreV1::StructuredPipeline, decorator: Google::Apis::FirestoreV1::StructuredPipeline::Representation
1091
1108
 
1092
1109
  property :transaction, :base64 => true, as: 'transaction'
@@ -1831,6 +1848,8 @@ module Google
1831
1848
  property :page_size, as: 'pageSize'
1832
1849
  property :page_token, as: 'pageToken'
1833
1850
  property :read_time, as: 'readTime'
1851
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1852
+
1834
1853
  end
1835
1854
  end
1836
1855
 
@@ -1867,6 +1886,8 @@ module Google
1867
1886
 
1868
1887
  hash :labels, as: 'labels'
1869
1888
  property :remove_target, as: 'removeTarget'
1889
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1890
+
1870
1891
  end
1871
1892
  end
1872
1893
 
@@ -1921,6 +1942,8 @@ module Google
1921
1942
  property :page_token, as: 'pageToken'
1922
1943
  property :partition_count, :numeric_string => true, as: 'partitionCount'
1923
1944
  property :read_time, as: 'readTime'
1945
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
1946
+
1924
1947
  property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1::StructuredQuery, decorator: Google::Apis::FirestoreV1::StructuredQuery::Representation
1925
1948
 
1926
1949
  end
@@ -1990,9 +2013,18 @@ module Google
1990
2013
  end
1991
2014
  end
1992
2015
 
2016
+ class RequestOptions
2017
+ # @private
2018
+ class Representation < Google::Apis::Core::JsonRepresentation
2019
+ collection :request_tags, as: 'requestTags'
2020
+ end
2021
+ end
2022
+
1993
2023
  class RollbackRequest
1994
2024
  # @private
1995
2025
  class Representation < Google::Apis::Core::JsonRepresentation
2026
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2027
+
1996
2028
  property :transaction, :base64 => true, as: 'transaction'
1997
2029
  end
1998
2030
  end
@@ -2005,6 +2037,8 @@ module Google
2005
2037
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
2006
2038
 
2007
2039
  property :read_time, as: 'readTime'
2040
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2041
+
2008
2042
  property :structured_aggregation_query, as: 'structuredAggregationQuery', class: Google::Apis::FirestoreV1::StructuredAggregationQuery, decorator: Google::Apis::FirestoreV1::StructuredAggregationQuery::Representation
2009
2043
 
2010
2044
  property :transaction, :base64 => true, as: 'transaction'
@@ -2031,6 +2065,8 @@ module Google
2031
2065
  property :new_transaction, as: 'newTransaction', class: Google::Apis::FirestoreV1::TransactionOptions, decorator: Google::Apis::FirestoreV1::TransactionOptions::Representation
2032
2066
 
2033
2067
  property :read_time, as: 'readTime'
2068
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2069
+
2034
2070
  property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1::StructuredQuery, decorator: Google::Apis::FirestoreV1::StructuredQuery::Representation
2035
2071
 
2036
2072
  property :transaction, :base64 => true, as: 'transaction'
@@ -2214,6 +2250,8 @@ module Google
2214
2250
  # @private
2215
2251
  class Representation < Google::Apis::Core::JsonRepresentation
2216
2252
  hash :labels, as: 'labels'
2253
+ property :request_options, as: 'requestOptions', class: Google::Apis::FirestoreV1::RequestOptions, decorator: Google::Apis::FirestoreV1::RequestOptions::Representation
2254
+
2217
2255
  property :stream_id, as: 'streamId'
2218
2256
  property :stream_token, :base64 => true, as: 'streamToken'
2219
2257
  collection :writes, as: 'writes', class: Google::Apis::FirestoreV1::Write, decorator: Google::Apis::FirestoreV1::Write::Representation
@@ -1029,6 +1029,8 @@ module Google
1029
1029
  # @param [Array<String>, String] mask_field_paths
1030
1030
  # The list of field paths in the mask. See Document.fields for a field path
1031
1031
  # syntax reference.
1032
+ # @param [Array<String>, String] request_options_request_tags
1033
+ # Optional. The request tags for the request.
1032
1034
  # @param [String] fields
1033
1035
  # Selector specifying which fields to include in a partial response.
1034
1036
  # @param [String] quota_user
@@ -1046,7 +1048,7 @@ module Google
1046
1048
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1047
1049
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1048
1050
  # @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)
1051
+ 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
1052
  command = make_simple_command(:post, 'v1/{+parent}/{collectionId}', options)
1051
1053
  command.request_representation = Google::Apis::FirestoreV1::Document::Representation
1052
1054
  command.request_object = document_object
@@ -1056,6 +1058,7 @@ module Google
1056
1058
  command.params['collectionId'] = collection_id unless collection_id.nil?
1057
1059
  command.query['documentId'] = document_id unless document_id.nil?
1058
1060
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
1061
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1059
1062
  command.query['fields'] = fields unless fields.nil?
1060
1063
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1061
1064
  execute_or_queue_command(command, &block)
@@ -1071,6 +1074,8 @@ module Google
1071
1074
  # @param [String] current_document_update_time
1072
1075
  # When set, the target document must exist and have been last updated at that
1073
1076
  # time. Timestamp must be microsecond aligned.
1077
+ # @param [Array<String>, String] request_options_request_tags
1078
+ # Optional. The request tags for the request.
1074
1079
  # @param [String] fields
1075
1080
  # Selector specifying which fields to include in a partial response.
1076
1081
  # @param [String] quota_user
@@ -1088,13 +1093,14 @@ module Google
1088
1093
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1089
1094
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1090
1095
  # @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)
1096
+ 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
1097
  command = make_simple_command(:delete, 'v1/{+name}', options)
1093
1098
  command.response_representation = Google::Apis::FirestoreV1::Empty::Representation
1094
1099
  command.response_class = Google::Apis::FirestoreV1::Empty
1095
1100
  command.params['name'] = name unless name.nil?
1096
1101
  command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
1097
1102
  command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
1103
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1098
1104
  command.query['fields'] = fields unless fields.nil?
1099
1105
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1100
1106
  execute_or_queue_command(command, &block)
@@ -1146,6 +1152,8 @@ module Google
1146
1152
  # microsecond precision timestamp within the past one hour, or if Point-in-Time
1147
1153
  # Recovery is enabled, can additionally be a whole minute timestamp within the
1148
1154
  # past 7 days.
1155
+ # @param [Array<String>, String] request_options_request_tags
1156
+ # Optional. The request tags for the request.
1149
1157
  # @param [String] transaction
1150
1158
  # Reads the document in a transaction.
1151
1159
  # @param [String] fields
@@ -1165,13 +1173,14 @@ module Google
1165
1173
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1166
1174
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1167
1175
  # @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)
1176
+ 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
1177
  command = make_simple_command(:get, 'v1/{+name}', options)
1170
1178
  command.response_representation = Google::Apis::FirestoreV1::Document::Representation
1171
1179
  command.response_class = Google::Apis::FirestoreV1::Document
1172
1180
  command.params['name'] = name unless name.nil?
1173
1181
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
1174
1182
  command.query['readTime'] = read_time unless read_time.nil?
1183
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1175
1184
  command.query['transaction'] = transaction unless transaction.nil?
1176
1185
  command.query['fields'] = fields unless fields.nil?
1177
1186
  command.query['quotaUser'] = quota_user unless quota_user.nil?
@@ -1209,6 +1218,15 @@ module Google
1209
1218
  # Perform the read at the provided time. This must be a microsecond precision
1210
1219
  # timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
1211
1220
  # can additionally be a whole minute timestamp within the past 7 days.
1221
+ # @param [Boolean] recursive
1222
+ # Optional. If the list should recursively include all documents nested under
1223
+ # the parent at any level. If the request specifies a `collection_id`, then the
1224
+ # list will include all nested documents in the collection under the parent.
1225
+ # This is optional, and when not provided, Firestore will only list documents
1226
+ # nested immediately under the parent. Requests with `recursive` may not specify
1227
+ # `show_missing`.
1228
+ # @param [Array<String>, String] request_options_request_tags
1229
+ # Optional. The request tags for the request.
1212
1230
  # @param [Boolean] show_missing
1213
1231
  # If the list should show missing documents. A document is missing if it does
1214
1232
  # not exist, but there are sub-documents nested underneath it. When true, such
@@ -1234,7 +1252,7 @@ module Google
1234
1252
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1235
1253
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1236
1254
  # @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)
1255
+ 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
1256
  command = make_simple_command(:get, 'v1/{+parent}/{collectionId}', options)
1239
1257
  command.response_representation = Google::Apis::FirestoreV1::ListDocumentsResponse::Representation
1240
1258
  command.response_class = Google::Apis::FirestoreV1::ListDocumentsResponse
@@ -1245,6 +1263,8 @@ module Google
1245
1263
  command.query['pageSize'] = page_size unless page_size.nil?
1246
1264
  command.query['pageToken'] = page_token unless page_token.nil?
1247
1265
  command.query['readTime'] = read_time unless read_time.nil?
1266
+ command.query['recursive'] = recursive unless recursive.nil?
1267
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1248
1268
  command.query['showMissing'] = show_missing unless show_missing.nil?
1249
1269
  command.query['transaction'] = transaction unless transaction.nil?
1250
1270
  command.query['fields'] = fields unless fields.nil?
@@ -1319,6 +1339,15 @@ module Google
1319
1339
  # Perform the read at the provided time. This must be a microsecond precision
1320
1340
  # timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
1321
1341
  # can additionally be a whole minute timestamp within the past 7 days.
1342
+ # @param [Boolean] recursive
1343
+ # Optional. If the list should recursively include all documents nested under
1344
+ # the parent at any level. If the request specifies a `collection_id`, then the
1345
+ # list will include all nested documents in the collection under the parent.
1346
+ # This is optional, and when not provided, Firestore will only list documents
1347
+ # nested immediately under the parent. Requests with `recursive` may not specify
1348
+ # `show_missing`.
1349
+ # @param [Array<String>, String] request_options_request_tags
1350
+ # Optional. The request tags for the request.
1322
1351
  # @param [Boolean] show_missing
1323
1352
  # If the list should show missing documents. A document is missing if it does
1324
1353
  # not exist, but there are sub-documents nested underneath it. When true, such
@@ -1344,7 +1373,7 @@ module Google
1344
1373
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1345
1374
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1346
1375
  # @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)
1376
+ 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
1377
  command = make_simple_command(:get, 'v1/{+parent}/{collectionId}', options)
1349
1378
  command.response_representation = Google::Apis::FirestoreV1::ListDocumentsResponse::Representation
1350
1379
  command.response_class = Google::Apis::FirestoreV1::ListDocumentsResponse
@@ -1355,6 +1384,8 @@ module Google
1355
1384
  command.query['pageSize'] = page_size unless page_size.nil?
1356
1385
  command.query['pageToken'] = page_token unless page_token.nil?
1357
1386
  command.query['readTime'] = read_time unless read_time.nil?
1387
+ command.query['recursive'] = recursive unless recursive.nil?
1388
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1358
1389
  command.query['showMissing'] = show_missing unless show_missing.nil?
1359
1390
  command.query['transaction'] = transaction unless transaction.nil?
1360
1391
  command.query['fields'] = fields unless fields.nil?
@@ -1448,6 +1479,8 @@ module Google
1448
1479
  # @param [Array<String>, String] mask_field_paths
1449
1480
  # The list of field paths in the mask. See Document.fields for a field path
1450
1481
  # syntax reference.
1482
+ # @param [Array<String>, String] request_options_request_tags
1483
+ # Optional. The request tags for the request.
1451
1484
  # @param [Array<String>, String] update_mask_field_paths
1452
1485
  # The list of field paths in the mask. See Document.fields for a field path
1453
1486
  # syntax reference.
@@ -1468,7 +1501,7 @@ module Google
1468
1501
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1469
1502
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1470
1503
  # @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)
1504
+ 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
1505
  command = make_simple_command(:patch, 'v1/{+name}', options)
1473
1506
  command.request_representation = Google::Apis::FirestoreV1::Document::Representation
1474
1507
  command.request_object = document_object
@@ -1478,6 +1511,7 @@ module Google
1478
1511
  command.query['currentDocument.exists'] = current_document_exists unless current_document_exists.nil?
1479
1512
  command.query['currentDocument.updateTime'] = current_document_update_time unless current_document_update_time.nil?
1480
1513
  command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
1514
+ command.query['requestOptions.requestTags'] = request_options_request_tags unless request_options_request_tags.nil?
1481
1515
  command.query['updateMask.fieldPaths'] = update_mask_field_paths unless update_mask_field_paths.nil?
1482
1516
  command.query['fields'] = fields unless fields.nil?
1483
1517
  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.95.0
4
+ version: 0.97.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.95.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.97.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: