google-cloud-firestore-v1 1.1.1 → 1.3.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.
Files changed (14) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -21
  3. data/lib/google/cloud/firestore/v1/firestore/client.rb +63 -17
  4. data/lib/google/cloud/firestore/v1/firestore/rest/client.rb +64 -12
  5. data/lib/google/cloud/firestore/v1/firestore/rest/service_stub.rb +105 -68
  6. data/lib/google/cloud/firestore/v1/version.rb +1 -1
  7. data/proto_docs/google/api/client.rb +39 -0
  8. data/proto_docs/google/firestore/v1/common.rb +8 -0
  9. data/proto_docs/google/firestore/v1/document.rb +22 -0
  10. data/proto_docs/google/firestore/v1/firestore.rb +52 -0
  11. data/proto_docs/google/firestore/v1/query.rb +12 -0
  12. data/proto_docs/google/firestore/v1/write.rb +18 -0
  13. data/proto_docs/google/protobuf/struct.rb +12 -0
  14. metadata +6 -9
data/lib/google/cloud/firestore/v1/firestore/rest/service_stub.rb CHANGED
@@ -30,7 +30,8 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
34
35
  # These require statements are intentionally placed here to initialize
35
36
  # the REST modules only when it's required.
36
37
  require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
40
41
  universe_domain: universe_domain,
41
42
  credentials: credentials,
42
43
  numeric_enums: true,
43
- raise_faraday_errors: false
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
44
47
  end
45
48
 
46
49
  ##
@@ -61,6 +64,15 @@ module Google
61
64
  @client_stub.endpoint
62
65
  end
63
66
 
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
64
76
  ##
65
77
  # Baseline implementation for the get_document REST call
66
78
  #
@@ -87,16 +99,18 @@ module Google
87
99
 
88
100
  response = @client_stub.make_http_request(
89
101
  verb,
90
- uri: uri,
91
- body: body || "",
92
- params: query_string_params,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "get_document",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::Firestore::V1::Document.decode_json response.body, ignore_unknown_fields: true
97
-
98
- yield result, operation if block_given?
99
- result
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
100
114
  end
101
115
 
102
116
  ##
@@ -125,16 +139,18 @@ module Google
125
139
 
126
140
  response = @client_stub.make_http_request(
127
141
  verb,
128
- uri: uri,
129
- body: body || "",
130
- params: query_string_params,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "list_documents",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::Firestore::V1::ListDocumentsResponse.decode_json response.body, ignore_unknown_fields: true
135
-
136
- yield result, operation if block_given?
137
- result
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
138
154
  end
139
155
 
140
156
  ##
@@ -163,16 +179,18 @@ module Google
163
179
 
164
180
  response = @client_stub.make_http_request(
165
181
  verb,
166
- uri: uri,
167
- body: body || "",
168
- params: query_string_params,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "update_document",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::Firestore::V1::Document.decode_json response.body, ignore_unknown_fields: true
173
-
174
- yield result, operation if block_given?
175
- result
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
176
194
  end
177
195
 
178
196
  ##
@@ -201,16 +219,18 @@ module Google
201
219
 
202
220
  response = @client_stub.make_http_request(
203
221
  verb,
204
- uri: uri,
205
- body: body || "",
206
- params: query_string_params,
222
+ uri: uri,
223
+ body: body || "",
224
+ params: query_string_params,
225
+ method_name: "delete_document",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
211
-
212
- yield result, operation if block_given?
213
- result
230
+ catch :response do
231
+ yield result, operation if block_given?
232
+ result
233
+ end
214
234
  end
215
235
 
216
236
  ##
@@ -239,6 +259,7 @@ module Google
239
259
  uri: uri,
240
260
  body: body || "",
241
261
  params: query_string_params,
262
+ method_name: "batch_get_documents",
242
263
  options: options,
243
264
  is_server_streaming: true,
244
265
  &block
@@ -272,16 +293,18 @@ module Google
272
293
 
273
294
  response = @client_stub.make_http_request(
274
295
  verb,
275
- uri: uri,
276
- body: body || "",
277
- params: query_string_params,
296
+ uri: uri,
297
+ body: body || "",
298
+ params: query_string_params,
299
+ method_name: "begin_transaction",
278
300
  options: options
279
301
  )
280
302
  operation = ::Gapic::Rest::TransportOperation.new response
281
303
  result = ::Google::Cloud::Firestore::V1::BeginTransactionResponse.decode_json response.body, ignore_unknown_fields: true
282
-
283
- yield result, operation if block_given?
284
- result
304
+ catch :response do
305
+ yield result, operation if block_given?
306
+ result
307
+ end
285
308
  end
286
309
 
287
310
  ##
@@ -310,16 +333,18 @@ module Google
310
333
 
311
334
  response = @client_stub.make_http_request(
312
335
  verb,
313
- uri: uri,
314
- body: body || "",
315
- params: query_string_params,
336
+ uri: uri,
337
+ body: body || "",
338
+ params: query_string_params,
339
+ method_name: "commit",
316
340
  options: options
317
341
  )
318
342
  operation = ::Gapic::Rest::TransportOperation.new response
319
343
  result = ::Google::Cloud::Firestore::V1::CommitResponse.decode_json response.body, ignore_unknown_fields: true
320
-
321
- yield result, operation if block_given?
322
- result
344
+ catch :response do
345
+ yield result, operation if block_given?
346
+ result
347
+ end
323
348
  end
324
349
 
325
350
  ##
@@ -348,16 +373,18 @@ module Google
348
373
 
349
374
  response = @client_stub.make_http_request(
350
375
  verb,
351
- uri: uri,
352
- body: body || "",
353
- params: query_string_params,
376
+ uri: uri,
377
+ body: body || "",
378
+ params: query_string_params,
379
+ method_name: "rollback",
354
380
  options: options
355
381
  )
356
382
  operation = ::Gapic::Rest::TransportOperation.new response
357
383
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
358
-
359
- yield result, operation if block_given?
360
- result
384
+ catch :response do
385
+ yield result, operation if block_given?
386
+ result
387
+ end
361
388
  end
362
389
 
363
390
  ##
@@ -386,6 +413,7 @@ module Google
386
413
  uri: uri,
387
414
  body: body || "",
388
415
  params: query_string_params,
416
+ method_name: "run_query",
389
417
  options: options,
390
418
  is_server_streaming: true,
391
419
  &block
@@ -419,6 +447,7 @@ module Google
419
447
  uri: uri,
420
448
  body: body || "",
421
449
  params: query_string_params,
450
+ method_name: "run_aggregation_query",
422
451
  options: options,
423
452
  is_server_streaming: true,
424
453
  &block
@@ -452,16 +481,18 @@ module Google
452
481
 
453
482
  response = @client_stub.make_http_request(
454
483
  verb,
455
- uri: uri,
456
- body: body || "",
457
- params: query_string_params,
484
+ uri: uri,
485
+ body: body || "",
486
+ params: query_string_params,
487
+ method_name: "partition_query",
458
488
  options: options
459
489
  )
460
490
  operation = ::Gapic::Rest::TransportOperation.new response
461
491
  result = ::Google::Cloud::Firestore::V1::PartitionQueryResponse.decode_json response.body, ignore_unknown_fields: true
462
-
463
- yield result, operation if block_given?
464
- result
492
+ catch :response do
493
+ yield result, operation if block_given?
494
+ result
495
+ end
465
496
  end
466
497
 
467
498
  ##
@@ -490,16 +521,18 @@ module Google
490
521
 
491
522
  response = @client_stub.make_http_request(
492
523
  verb,
493
- uri: uri,
494
- body: body || "",
495
- params: query_string_params,
524
+ uri: uri,
525
+ body: body || "",
526
+ params: query_string_params,
527
+ method_name: "list_collection_ids",
496
528
  options: options
497
529
  )
498
530
  operation = ::Gapic::Rest::TransportOperation.new response
499
531
  result = ::Google::Cloud::Firestore::V1::ListCollectionIdsResponse.decode_json response.body, ignore_unknown_fields: true
500
-
501
- yield result, operation if block_given?
502
- result
532
+ catch :response do
533
+ yield result, operation if block_given?
534
+ result
535
+ end
503
536
  end
504
537
 
505
538
  ##
@@ -528,16 +561,18 @@ module Google
528
561
 
529
562
  response = @client_stub.make_http_request(
530
563
  verb,
531
- uri: uri,
532
- body: body || "",
533
- params: query_string_params,
564
+ uri: uri,
565
+ body: body || "",
566
+ params: query_string_params,
567
+ method_name: "batch_write",
534
568
  options: options
535
569
  )
536
570
  operation = ::Gapic::Rest::TransportOperation.new response
537
571
  result = ::Google::Cloud::Firestore::V1::BatchWriteResponse.decode_json response.body, ignore_unknown_fields: true
538
-
539
- yield result, operation if block_given?
540
- result
572
+ catch :response do
573
+ yield result, operation if block_given?
574
+ result
575
+ end
541
576
  end
542
577
 
543
578
  ##
@@ -566,16 +601,18 @@ module Google
566
601
 
567
602
  response = @client_stub.make_http_request(
568
603
  verb,
569
- uri: uri,
570
- body: body || "",
571
- params: query_string_params,
604
+ uri: uri,
605
+ body: body || "",
606
+ params: query_string_params,
607
+ method_name: "create_document",
572
608
  options: options
573
609
  )
574
610
  operation = ::Gapic::Rest::TransportOperation.new response
575
611
  result = ::Google::Cloud::Firestore::V1::Document.decode_json response.body, ignore_unknown_fields: true
576
-
577
- yield result, operation if block_given?
578
- result
612
+ catch :response do
613
+ yield result, operation if block_given?
614
+ result
615
+ end
579
616
  end
580
617
 
581
618
  ##
data/lib/google/cloud/firestore/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Firestore
23
23
  module V1
24
- VERSION = "1.1.1"
24
+ VERSION = "1.3.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -28,6 +28,9 @@ module Google
28
28
  # @!attribute [rw] destinations
29
29
  # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
30
  # The destination where API teams want this client library to be published.
31
+ # @!attribute [rw] selective_gapic_generation
32
+ # @return [::Google::Api::SelectiveGapicGeneration]
33
+ # Configuration for which RPCs should be generated in the GAPIC client.
31
34
  class CommonLanguageSettings
32
35
  include ::Google::Protobuf::MessageExts
33
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
212
215
  # enabled. By default, asynchronous REST clients will not be generated.
213
216
  # This feature will be enabled by default 1 month after launching the
214
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
215
224
  class ExperimentalFeatures
216
225
  include ::Google::Protobuf::MessageExts
217
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,9 +306,28 @@ module Google
297
306
  # @!attribute [rw] common
298
307
  # @return [::Google::Api::CommonLanguageSettings]
299
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
300
319
  class GoSettings
301
320
  include ::Google::Protobuf::MessageExts
302
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
303
331
  end
304
332
 
305
333
  # Describes the generator configuration for a method.
@@ -375,6 +403,17 @@ module Google
375
403
  end
376
404
  end
377
405
 
406
+ # This message is used to configure the generation of a subset of the RPCs in
407
+ # a service for client libraries.
408
+ # @!attribute [rw] methods
409
+ # @return [::Array<::String>]
410
+ # An allowlist of the fully qualified names of RPCs that should be included
411
+ # on public client surfaces.
412
+ class SelectiveGapicGeneration
413
+ include ::Google::Protobuf::MessageExts
414
+ extend ::Google::Protobuf::MessageExts::ClassMethods
415
+ end
416
+
378
417
  # The organization for which the client libraries are being published.
379
418
  # Affects the url where generated docs are published, etc.
380
419
  module ClientLibraryOrganization
data/proto_docs/google/firestore/v1/common.rb CHANGED
@@ -42,10 +42,14 @@ module Google
42
42
  # @return [::Boolean]
43
43
  # When set to `true`, the target document must exist.
44
44
  # When set to `false`, the target document must not exist.
45
+ #
46
+ # Note: The following fields are mutually exclusive: `exists`, `update_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
45
47
  # @!attribute [rw] update_time
46
48
  # @return [::Google::Protobuf::Timestamp]
47
49
  # When set, the target document must exist and have been last updated at
48
50
  # that time. Timestamp must be microsecond aligned.
51
+ #
52
+ # Note: The following fields are mutually exclusive: `update_time`, `exists`. If a field in that set is populated, all other fields in the set will automatically be cleared.
49
53
  class Precondition
50
54
  include ::Google::Protobuf::MessageExts
51
55
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -55,9 +59,13 @@ module Google
55
59
  # @!attribute [rw] read_only
56
60
  # @return [::Google::Cloud::Firestore::V1::TransactionOptions::ReadOnly]
57
61
  # The transaction can only be used for read operations.
62
+ #
63
+ # Note: The following fields are mutually exclusive: `read_only`, `read_write`. If a field in that set is populated, all other fields in the set will automatically be cleared.
58
64
  # @!attribute [rw] read_write
59
65
  # @return [::Google::Cloud::Firestore::V1::TransactionOptions::ReadWrite]
60
66
  # The transaction can be used for both read and write operations.
67
+ #
68
+ # Note: The following fields are mutually exclusive: `read_write`, `read_only`. If a field in that set is populated, all other fields in the set will automatically be cleared.
61
69
  class TransactionOptions
62
70
  include ::Google::Protobuf::MessageExts
63
71
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/firestore/v1/document.rb CHANGED
@@ -86,21 +86,31 @@ module Google
86
86
  # @!attribute [rw] null_value
87
87
  # @return [::Google::Protobuf::NullValue]
88
88
  # A null value.
89
+ #
90
+ # Note: The following fields are mutually exclusive: `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
89
91
  # @!attribute [rw] boolean_value
90
92
  # @return [::Boolean]
91
93
  # A boolean value.
94
+ #
95
+ # Note: The following fields are mutually exclusive: `boolean_value`, `null_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
92
96
  # @!attribute [rw] integer_value
93
97
  # @return [::Integer]
94
98
  # An integer value.
99
+ #
100
+ # Note: The following fields are mutually exclusive: `integer_value`, `null_value`, `boolean_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
95
101
  # @!attribute [rw] double_value
96
102
  # @return [::Float]
97
103
  # A double value.
104
+ #
105
+ # Note: The following fields are mutually exclusive: `double_value`, `null_value`, `boolean_value`, `integer_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
98
106
  # @!attribute [rw] timestamp_value
99
107
  # @return [::Google::Protobuf::Timestamp]
100
108
  # A timestamp value.
101
109
  #
102
110
  # Precise only to microseconds. When stored, any additional precision is
103
111
  # rounded down.
112
+ #
113
+ # Note: The following fields are mutually exclusive: `timestamp_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
104
114
  # @!attribute [rw] string_value
105
115
  # @return [::String]
106
116
  # A string value.
@@ -108,28 +118,40 @@ module Google
108
118
  # The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.
109
119
  # Only the first 1,500 bytes of the UTF-8 representation are considered by
110
120
  # queries.
121
+ #
122
+ # Note: The following fields are mutually exclusive: `string_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
111
123
  # @!attribute [rw] bytes_value
112
124
  # @return [::String]
113
125
  # A bytes value.
114
126
  #
115
127
  # Must not exceed 1 MiB - 89 bytes.
116
128
  # Only the first 1,500 bytes are considered by queries.
129
+ #
130
+ # Note: The following fields are mutually exclusive: `bytes_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `reference_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
117
131
  # @!attribute [rw] reference_value
118
132
  # @return [::String]
119
133
  # A reference to a document. For example:
120
134
  # `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
135
+ #
136
+ # Note: The following fields are mutually exclusive: `reference_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `geo_point_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
121
137
  # @!attribute [rw] geo_point_value
122
138
  # @return [::Google::Type::LatLng]
123
139
  # A geo point value representing a point on the surface of Earth.
140
+ #
141
+ # Note: The following fields are mutually exclusive: `geo_point_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `array_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
124
142
  # @!attribute [rw] array_value
125
143
  # @return [::Google::Cloud::Firestore::V1::ArrayValue]
126
144
  # An array value.
127
145
  #
128
146
  # Cannot directly contain another array value, though can contain a
129
147
  # map which contains another array.
148
+ #
149
+ # Note: The following fields are mutually exclusive: `array_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `map_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
130
150
  # @!attribute [rw] map_value
131
151
  # @return [::Google::Cloud::Firestore::V1::MapValue]
132
152
  # A map value.
153
+ #
154
+ # Note: The following fields are mutually exclusive: `map_value`, `null_value`, `boolean_value`, `integer_value`, `double_value`, `timestamp_value`, `string_value`, `bytes_value`, `reference_value`, `geo_point_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
133
155
  class Value
134
156
  include ::Google::Protobuf::MessageExts
135
157
  extend ::Google::Protobuf::MessageExts::ClassMethods