google-cloud-firestore-admin-v1 0.3.1 → 0.3.5

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4e9d468852968a337bc37cb494ab82d98afd761460af79d77a80e8472e6f53f6
4
- data.tar.gz: d4d368d36bca1c68f0050b252c9dc3b4052afdb1f7db3d3e764d2329b6451ad4
3
+ metadata.gz: e576925bd653ff87f65db14f1a1727775a42bf509afbbb4e27ac6793b5111dd6
4
+ data.tar.gz: 015c2e510cb1c8b64602c3d95fa781e5111d10b3af7183f2499e6428e194d663
5
5
  SHA512:
6
- metadata.gz: 7042c43475b0a06e8dff6d5092f2188f95143e93ca98636ad7082bb8dd1f4a9db047b5d2a0d409ae8e18244484bf0b18044d3e7846760854eeddf13c5850d985
7
- data.tar.gz: 91e2bf7e78cbfeba72f8cc6daec99be054b50900e04688aae9f07ee1a53aa775b915038533883059f28c948ba692f5453dfbc018336c92bca2bbb43b06854411
6
+ metadata.gz: 377663b172b3593969409b7ad3280eb8e04eebec7a7425ac85ad67b8e634d3fcca6361b45798fcb9fc92f97b5b01d68dfee555dbf7e7a8b04dc0f1f3feca94c2
7
+ data.tar.gz: 3ba5cedc5b07b6f52c693a3f1a09387475e4bda2b2b7a232bf1a043c166ce3d9fe37ecba2278de35f24744e23df43795fbfc3e0042970188d02df946a8cf3a32
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-firestore-admin-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Credentials}):
68
68
 
69
- 1. `FIRESTORE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `FIRESTORE_KEYFILE` - Path to JSON file, or JSON contents
71
- 3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- 4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- 5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
69
+ * `FIRESTORE_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `FIRESTORE_KEYFILE` - Path to JSON file, or JSON contents
71
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
+ * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
74
74
 
75
75
  ```ruby
76
76
  require "google/cloud/firestore/admin/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
82
82
 
83
83
  ### Configuration
84
84
 
85
- The **Credentials JSON** can be configured instead of placing them in
86
- environment variables. Either on an individual client initialization:
85
+ The path to the **Credentials JSON** file can be configured instead of storing
86
+ it in an environment variable. Either on an individual client initialization:
87
87
 
88
88
  ```ruby
89
89
  require "google/cloud/firestore/admin/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |c
93
93
  end
94
94
  ```
95
95
 
96
- Or configured globally for all clients:
96
+ Or globally for all clients:
97
97
 
98
98
  ```ruby
99
99
  require "google/cloud/firestore/admin/v1"
data/README.md CHANGED
@@ -9,7 +9,7 @@ https://github.com/googleapis/google-cloud-ruby
9
9
  This gem is a _versioned_ client. It provides basic client classes for a
10
10
  specific version of the Cloud Firestore Admin V1 API. Most users should consider using
11
11
  the main client gem,
12
- [google-cloud-firestore-admin](https://rubygems.org/gems/google-cloud-firestore-admin).
12
+ [google-cloud-firestore](https://rubygems.org/gems/google-cloud-firestore).
13
13
  See the section below titled *Which client should I use?* for more information.
14
14
 
15
15
  ## Installation
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/firestore/admin/v1"
34
34
 
35
35
  client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest.new # (request fields as keyword arguments...)
37
37
  response = client.create_index request
38
38
  ```
39
39
 
@@ -83,7 +83,7 @@ about the Ruby support schedule.
83
83
  ## Which client should I use?
84
84
 
85
85
  Most modern Ruby client libraries for Google APIs come in two flavors: the main
86
- client library with a name such as `google-cloud-firestore-admin`,
86
+ client library with a name such as `google-cloud-firestore`,
87
87
  and lower-level _versioned_ client libraries with names such as
88
88
  `google-cloud-firestore-admin-v1`.
89
89
  _In most cases, you should install the main client._
@@ -110,7 +110,7 @@ service version.
110
110
 
111
111
  We recommend that most users install the main client gem for a service. You can
112
112
  identify this gem as the one _without_ a version in its name, e.g.
113
- `google-cloud-firestore-admin`.
113
+ `google-cloud-firestore`.
114
114
  The main client is recommended because it will embody the best practices for
115
115
  accessing the service, and may also provide more convenient interfaces or
116
116
  tighter integration into frameworks and third-party libraries. In addition, the
@@ -43,13 +43,12 @@ module Google
43
43
  # See {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration}
44
44
  # for a description of the configuration fields.
45
45
  #
46
- # ## Example
46
+ # @example
47
47
  #
48
- # To modify the configuration for all FirestoreAdmin clients:
49
- #
50
- # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
51
- # config.timeout = 10.0
52
- # end
48
+ # # Modify the configuration for all FirestoreAdmin clients
49
+ # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
50
+ # config.timeout = 10.0
51
+ # end
53
52
  #
54
53
  # @yield [config] Configure the Client client.
55
54
  # @yieldparam config [Client::Configuration]
@@ -71,44 +70,29 @@ module Google
71
70
 
72
71
  default_config.rpcs.list_indexes.timeout = 60.0
73
72
  default_config.rpcs.list_indexes.retry_policy = {
74
- initial_delay: 0.1,
75
- max_delay: 60.0,
76
- multiplier: 1.3,
77
- retry_codes: [14, 13, 4]
73
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
78
74
  }
79
75
 
80
76
  default_config.rpcs.get_index.timeout = 60.0
81
77
  default_config.rpcs.get_index.retry_policy = {
82
- initial_delay: 0.1,
83
- max_delay: 60.0,
84
- multiplier: 1.3,
85
- retry_codes: [14, 13, 4]
78
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
86
79
  }
87
80
 
88
81
  default_config.rpcs.delete_index.timeout = 60.0
89
82
  default_config.rpcs.delete_index.retry_policy = {
90
- initial_delay: 0.1,
91
- max_delay: 60.0,
92
- multiplier: 1.3,
93
- retry_codes: [14, 13, 4]
83
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
94
84
  }
95
85
 
96
86
  default_config.rpcs.get_field.timeout = 60.0
97
87
  default_config.rpcs.get_field.retry_policy = {
98
- initial_delay: 0.1,
99
- max_delay: 60.0,
100
- multiplier: 1.3,
101
- retry_codes: [14, 13, 4]
88
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
102
89
  }
103
90
 
104
91
  default_config.rpcs.update_field.timeout = 60.0
105
92
 
106
93
  default_config.rpcs.list_fields.timeout = 60.0
107
94
  default_config.rpcs.list_fields.retry_policy = {
108
- initial_delay: 0.1,
109
- max_delay: 60.0,
110
- multiplier: 1.3,
111
- retry_codes: [14, 13, 4]
95
+ initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
112
96
  }
113
97
 
114
98
  default_config.rpcs.export_documents.timeout = 60.0
@@ -144,19 +128,15 @@ module Google
144
128
  ##
145
129
  # Create a new FirestoreAdmin client object.
146
130
  #
147
- # ## Examples
148
- #
149
- # To create a new FirestoreAdmin client with the default
150
- # configuration:
151
- #
152
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
131
+ # @example
153
132
  #
154
- # To create a new FirestoreAdmin client with a custom
155
- # configuration:
133
+ # # Create a client using the default configuration
134
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
156
135
  #
157
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
158
- # config.timeout = 10.0
159
- # end
136
+ # # Create a client using a custom configuration
137
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
138
+ # config.timeout = 10.0
139
+ # end
160
140
  #
161
141
  # @yield [config] Configure the FirestoreAdmin client.
162
142
  # @yieldparam config [Client::Configuration]
@@ -176,14 +156,13 @@ module Google
176
156
 
177
157
  # Create credentials
178
158
  credentials = @config.credentials
179
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
159
+ # Use self-signed JWT if the endpoint is unchanged from default,
180
160
  # but only if the default endpoint does not have a region prefix.
181
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
182
- @config.endpoint == Client.configure.endpoint &&
161
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
183
162
  !@config.endpoint.split(".").first.include?("-")
184
163
  credentials ||= Credentials.default scope: @config.scope,
185
164
  enable_self_signed_jwt: enable_self_signed_jwt
186
- if credentials.is_a?(String) || credentials.is_a?(Hash)
165
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
187
166
  credentials = Credentials.new credentials, scope: @config.scope
188
167
  end
189
168
  @quota_project_id = @config.quota_project
@@ -246,6 +225,28 @@ module Google
246
225
  #
247
226
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
248
227
  #
228
+ # @example Basic example
229
+ # require "google/cloud/firestore/admin/v1"
230
+ #
231
+ # # Create a client object. The client can be reused for multiple calls.
232
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
233
+ #
234
+ # # Create a request. To set request fields, pass in keyword arguments.
235
+ # request = Google::Cloud::Firestore::Admin::V1::CreateIndexRequest.new
236
+ #
237
+ # # Call the create_index method.
238
+ # result = client.create_index request
239
+ #
240
+ # # The returned object is of type Gapic::Operation. You can use this
241
+ # # object to check the status of an operation, cancel it, or wait
242
+ # # for results. Here is how to block until completion:
243
+ # result.wait_until_done! timeout: 60
244
+ # if result.response?
245
+ # p result.response
246
+ # else
247
+ # puts "Error!"
248
+ # end
249
+ #
249
250
  def create_index request, options = nil
250
251
  raise ::ArgumentError, "request must be provided" if request.nil?
251
252
 
@@ -263,16 +264,20 @@ module Google
263
264
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
264
265
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
265
266
 
266
- header_params = {
267
- "parent" => request.parent
268
- }
267
+ header_params = {}
268
+ if request.parent
269
+ header_params["parent"] = request.parent
270
+ end
271
+
269
272
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
270
273
  metadata[:"x-goog-request-params"] ||= request_params_header
271
274
 
272
275
  options.apply_defaults timeout: @config.rpcs.create_index.timeout,
273
276
  metadata: metadata,
274
277
  retry_policy: @config.rpcs.create_index.retry_policy
275
- options.apply_defaults metadata: @config.metadata,
278
+
279
+ options.apply_defaults timeout: @config.timeout,
280
+ metadata: @config.metadata,
276
281
  retry_policy: @config.retry_policy
277
282
 
278
283
  @firestore_admin_stub.call_rpc :create_index, request, options: options do |response, operation|
@@ -322,6 +327,27 @@ module Google
322
327
  #
323
328
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
324
329
  #
330
+ # @example Basic example
331
+ # require "google/cloud/firestore/admin/v1"
332
+ #
333
+ # # Create a client object. The client can be reused for multiple calls.
334
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
335
+ #
336
+ # # Create a request. To set request fields, pass in keyword arguments.
337
+ # request = Google::Cloud::Firestore::Admin::V1::ListIndexesRequest.new
338
+ #
339
+ # # Call the list_indexes method.
340
+ # result = client.list_indexes request
341
+ #
342
+ # # The returned object is of type Gapic::PagedEnumerable. You can
343
+ # # iterate over all elements by calling #each, and the enumerable
344
+ # # will lazily make API calls to fetch subsequent pages. Other
345
+ # # methods are also available for managing paging directly.
346
+ # result.each do |response|
347
+ # # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Index.
348
+ # p response
349
+ # end
350
+ #
325
351
  def list_indexes request, options = nil
326
352
  raise ::ArgumentError, "request must be provided" if request.nil?
327
353
 
@@ -339,16 +365,20 @@ module Google
339
365
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
340
366
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
341
367
 
342
- header_params = {
343
- "parent" => request.parent
344
- }
368
+ header_params = {}
369
+ if request.parent
370
+ header_params["parent"] = request.parent
371
+ end
372
+
345
373
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
346
374
  metadata[:"x-goog-request-params"] ||= request_params_header
347
375
 
348
376
  options.apply_defaults timeout: @config.rpcs.list_indexes.timeout,
349
377
  metadata: metadata,
350
378
  retry_policy: @config.rpcs.list_indexes.retry_policy
351
- options.apply_defaults metadata: @config.metadata,
379
+
380
+ options.apply_defaults timeout: @config.timeout,
381
+ metadata: @config.metadata,
352
382
  retry_policy: @config.retry_policy
353
383
 
354
384
  @firestore_admin_stub.call_rpc :list_indexes, request, options: options do |response, operation|
@@ -390,6 +420,21 @@ module Google
390
420
  #
391
421
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
392
422
  #
423
+ # @example Basic example
424
+ # require "google/cloud/firestore/admin/v1"
425
+ #
426
+ # # Create a client object. The client can be reused for multiple calls.
427
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
428
+ #
429
+ # # Create a request. To set request fields, pass in keyword arguments.
430
+ # request = Google::Cloud::Firestore::Admin::V1::GetIndexRequest.new
431
+ #
432
+ # # Call the get_index method.
433
+ # result = client.get_index request
434
+ #
435
+ # # The returned object is of type Google::Cloud::Firestore::Admin::V1::Index.
436
+ # p result
437
+ #
393
438
  def get_index request, options = nil
394
439
  raise ::ArgumentError, "request must be provided" if request.nil?
395
440
 
@@ -407,16 +452,20 @@ module Google
407
452
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
408
453
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
409
454
 
410
- header_params = {
411
- "name" => request.name
412
- }
455
+ header_params = {}
456
+ if request.name
457
+ header_params["name"] = request.name
458
+ end
459
+
413
460
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
414
461
  metadata[:"x-goog-request-params"] ||= request_params_header
415
462
 
416
463
  options.apply_defaults timeout: @config.rpcs.get_index.timeout,
417
464
  metadata: metadata,
418
465
  retry_policy: @config.rpcs.get_index.retry_policy
419
- options.apply_defaults metadata: @config.metadata,
466
+
467
+ options.apply_defaults timeout: @config.timeout,
468
+ metadata: @config.metadata,
420
469
  retry_policy: @config.retry_policy
421
470
 
422
471
  @firestore_admin_stub.call_rpc :get_index, request, options: options do |response, operation|
@@ -457,6 +506,21 @@ module Google
457
506
  #
458
507
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
459
508
  #
509
+ # @example Basic example
510
+ # require "google/cloud/firestore/admin/v1"
511
+ #
512
+ # # Create a client object. The client can be reused for multiple calls.
513
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
514
+ #
515
+ # # Create a request. To set request fields, pass in keyword arguments.
516
+ # request = Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest.new
517
+ #
518
+ # # Call the delete_index method.
519
+ # result = client.delete_index request
520
+ #
521
+ # # The returned object is of type Google::Protobuf::Empty.
522
+ # p result
523
+ #
460
524
  def delete_index request, options = nil
461
525
  raise ::ArgumentError, "request must be provided" if request.nil?
462
526
 
@@ -474,16 +538,20 @@ module Google
474
538
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
475
539
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
476
540
 
477
- header_params = {
478
- "name" => request.name
479
- }
541
+ header_params = {}
542
+ if request.name
543
+ header_params["name"] = request.name
544
+ end
545
+
480
546
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
481
547
  metadata[:"x-goog-request-params"] ||= request_params_header
482
548
 
483
549
  options.apply_defaults timeout: @config.rpcs.delete_index.timeout,
484
550
  metadata: metadata,
485
551
  retry_policy: @config.rpcs.delete_index.retry_policy
486
- options.apply_defaults metadata: @config.metadata,
552
+
553
+ options.apply_defaults timeout: @config.timeout,
554
+ metadata: @config.metadata,
487
555
  retry_policy: @config.retry_policy
488
556
 
489
557
  @firestore_admin_stub.call_rpc :delete_index, request, options: options do |response, operation|
@@ -524,6 +592,21 @@ module Google
524
592
  #
525
593
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
526
594
  #
595
+ # @example Basic example
596
+ # require "google/cloud/firestore/admin/v1"
597
+ #
598
+ # # Create a client object. The client can be reused for multiple calls.
599
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
600
+ #
601
+ # # Create a request. To set request fields, pass in keyword arguments.
602
+ # request = Google::Cloud::Firestore::Admin::V1::GetFieldRequest.new
603
+ #
604
+ # # Call the get_field method.
605
+ # result = client.get_field request
606
+ #
607
+ # # The returned object is of type Google::Cloud::Firestore::Admin::V1::Field.
608
+ # p result
609
+ #
527
610
  def get_field request, options = nil
528
611
  raise ::ArgumentError, "request must be provided" if request.nil?
529
612
 
@@ -541,16 +624,20 @@ module Google
541
624
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
542
625
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
543
626
 
544
- header_params = {
545
- "name" => request.name
546
- }
627
+ header_params = {}
628
+ if request.name
629
+ header_params["name"] = request.name
630
+ end
631
+
547
632
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
548
633
  metadata[:"x-goog-request-params"] ||= request_params_header
549
634
 
550
635
  options.apply_defaults timeout: @config.rpcs.get_field.timeout,
551
636
  metadata: metadata,
552
637
  retry_policy: @config.rpcs.get_field.retry_policy
553
- options.apply_defaults metadata: @config.metadata,
638
+
639
+ options.apply_defaults timeout: @config.timeout,
640
+ metadata: @config.metadata,
554
641
  retry_policy: @config.retry_policy
555
642
 
556
643
  @firestore_admin_stub.call_rpc :get_field, request, options: options do |response, operation|
@@ -605,6 +692,28 @@ module Google
605
692
  #
606
693
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
607
694
  #
695
+ # @example Basic example
696
+ # require "google/cloud/firestore/admin/v1"
697
+ #
698
+ # # Create a client object. The client can be reused for multiple calls.
699
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
700
+ #
701
+ # # Create a request. To set request fields, pass in keyword arguments.
702
+ # request = Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest.new
703
+ #
704
+ # # Call the update_field method.
705
+ # result = client.update_field request
706
+ #
707
+ # # The returned object is of type Gapic::Operation. You can use this
708
+ # # object to check the status of an operation, cancel it, or wait
709
+ # # for results. Here is how to block until completion:
710
+ # result.wait_until_done! timeout: 60
711
+ # if result.response?
712
+ # p result.response
713
+ # else
714
+ # puts "Error!"
715
+ # end
716
+ #
608
717
  def update_field request, options = nil
609
718
  raise ::ArgumentError, "request must be provided" if request.nil?
610
719
 
@@ -622,16 +731,20 @@ module Google
622
731
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
623
732
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
624
733
 
625
- header_params = {
626
- "field.name" => request.field.name
627
- }
734
+ header_params = {}
735
+ if request.field&.name
736
+ header_params["field.name"] = request.field.name
737
+ end
738
+
628
739
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
629
740
  metadata[:"x-goog-request-params"] ||= request_params_header
630
741
 
631
742
  options.apply_defaults timeout: @config.rpcs.update_field.timeout,
632
743
  metadata: metadata,
633
744
  retry_policy: @config.rpcs.update_field.retry_policy
634
- options.apply_defaults metadata: @config.metadata,
745
+
746
+ options.apply_defaults timeout: @config.timeout,
747
+ metadata: @config.metadata,
635
748
  retry_policy: @config.retry_policy
636
749
 
637
750
  @firestore_admin_stub.call_rpc :update_field, request, options: options do |response, operation|
@@ -690,6 +803,27 @@ module Google
690
803
  #
691
804
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
692
805
  #
806
+ # @example Basic example
807
+ # require "google/cloud/firestore/admin/v1"
808
+ #
809
+ # # Create a client object. The client can be reused for multiple calls.
810
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
811
+ #
812
+ # # Create a request. To set request fields, pass in keyword arguments.
813
+ # request = Google::Cloud::Firestore::Admin::V1::ListFieldsRequest.new
814
+ #
815
+ # # Call the list_fields method.
816
+ # result = client.list_fields request
817
+ #
818
+ # # The returned object is of type Gapic::PagedEnumerable. You can
819
+ # # iterate over all elements by calling #each, and the enumerable
820
+ # # will lazily make API calls to fetch subsequent pages. Other
821
+ # # methods are also available for managing paging directly.
822
+ # result.each do |response|
823
+ # # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Field.
824
+ # p response
825
+ # end
826
+ #
693
827
  def list_fields request, options = nil
694
828
  raise ::ArgumentError, "request must be provided" if request.nil?
695
829
 
@@ -707,16 +841,20 @@ module Google
707
841
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
708
842
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
709
843
 
710
- header_params = {
711
- "parent" => request.parent
712
- }
844
+ header_params = {}
845
+ if request.parent
846
+ header_params["parent"] = request.parent
847
+ end
848
+
713
849
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
714
850
  metadata[:"x-goog-request-params"] ||= request_params_header
715
851
 
716
852
  options.apply_defaults timeout: @config.rpcs.list_fields.timeout,
717
853
  metadata: metadata,
718
854
  retry_policy: @config.rpcs.list_fields.retry_policy
719
- options.apply_defaults metadata: @config.metadata,
855
+
856
+ options.apply_defaults timeout: @config.timeout,
857
+ metadata: @config.metadata,
720
858
  retry_policy: @config.retry_policy
721
859
 
722
860
  @firestore_admin_stub.call_rpc :list_fields, request, options: options do |response, operation|
@@ -776,6 +914,28 @@ module Google
776
914
  #
777
915
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
778
916
  #
917
+ # @example Basic example
918
+ # require "google/cloud/firestore/admin/v1"
919
+ #
920
+ # # Create a client object. The client can be reused for multiple calls.
921
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
922
+ #
923
+ # # Create a request. To set request fields, pass in keyword arguments.
924
+ # request = Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest.new
925
+ #
926
+ # # Call the export_documents method.
927
+ # result = client.export_documents request
928
+ #
929
+ # # The returned object is of type Gapic::Operation. You can use this
930
+ # # object to check the status of an operation, cancel it, or wait
931
+ # # for results. Here is how to block until completion:
932
+ # result.wait_until_done! timeout: 60
933
+ # if result.response?
934
+ # p result.response
935
+ # else
936
+ # puts "Error!"
937
+ # end
938
+ #
779
939
  def export_documents request, options = nil
780
940
  raise ::ArgumentError, "request must be provided" if request.nil?
781
941
 
@@ -793,16 +953,20 @@ module Google
793
953
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
794
954
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
795
955
 
796
- header_params = {
797
- "name" => request.name
798
- }
956
+ header_params = {}
957
+ if request.name
958
+ header_params["name"] = request.name
959
+ end
960
+
799
961
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
800
962
  metadata[:"x-goog-request-params"] ||= request_params_header
801
963
 
802
964
  options.apply_defaults timeout: @config.rpcs.export_documents.timeout,
803
965
  metadata: metadata,
804
966
  retry_policy: @config.rpcs.export_documents.retry_policy
805
- options.apply_defaults metadata: @config.metadata,
967
+
968
+ options.apply_defaults timeout: @config.timeout,
969
+ metadata: @config.metadata,
806
970
  retry_policy: @config.retry_policy
807
971
 
808
972
  @firestore_admin_stub.call_rpc :export_documents, request, options: options do |response, operation|
@@ -857,6 +1021,28 @@ module Google
857
1021
  #
858
1022
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
859
1023
  #
1024
+ # @example Basic example
1025
+ # require "google/cloud/firestore/admin/v1"
1026
+ #
1027
+ # # Create a client object. The client can be reused for multiple calls.
1028
+ # client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
1029
+ #
1030
+ # # Create a request. To set request fields, pass in keyword arguments.
1031
+ # request = Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest.new
1032
+ #
1033
+ # # Call the import_documents method.
1034
+ # result = client.import_documents request
1035
+ #
1036
+ # # The returned object is of type Gapic::Operation. You can use this
1037
+ # # object to check the status of an operation, cancel it, or wait
1038
+ # # for results. Here is how to block until completion:
1039
+ # result.wait_until_done! timeout: 60
1040
+ # if result.response?
1041
+ # p result.response
1042
+ # else
1043
+ # puts "Error!"
1044
+ # end
1045
+ #
860
1046
  def import_documents request, options = nil
861
1047
  raise ::ArgumentError, "request must be provided" if request.nil?
862
1048
 
@@ -874,16 +1060,20 @@ module Google
874
1060
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
875
1061
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
876
1062
 
877
- header_params = {
878
- "name" => request.name
879
- }
1063
+ header_params = {}
1064
+ if request.name
1065
+ header_params["name"] = request.name
1066
+ end
1067
+
880
1068
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
881
1069
  metadata[:"x-goog-request-params"] ||= request_params_header
882
1070
 
883
1071
  options.apply_defaults timeout: @config.rpcs.import_documents.timeout,
884
1072
  metadata: metadata,
885
1073
  retry_policy: @config.rpcs.import_documents.retry_policy
886
- options.apply_defaults metadata: @config.metadata,
1074
+
1075
+ options.apply_defaults timeout: @config.timeout,
1076
+ metadata: @config.metadata,
887
1077
  retry_policy: @config.retry_policy
888
1078
 
889
1079
  @firestore_admin_stub.call_rpc :import_documents, request, options: options do |response, operation|
@@ -908,22 +1098,21 @@ module Google
908
1098
  # Configuration can be applied globally to all clients, or to a single client
909
1099
  # on construction.
910
1100
  #
911
- # # Examples
912
- #
913
- # To modify the global config, setting the timeout for create_index
914
- # to 20 seconds, and all remaining timeouts to 10 seconds:
915
- #
916
- # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
917
- # config.timeout = 10.0
918
- # config.rpcs.create_index.timeout = 20.0
919
- # end
920
- #
921
- # To apply the above configuration only to a new client:
922
- #
923
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
924
- # config.timeout = 10.0
925
- # config.rpcs.create_index.timeout = 20.0
926
- # end
1101
+ # @example
1102
+ #
1103
+ # # Modify the global config, setting the timeout for
1104
+ # # create_index to 20 seconds,
1105
+ # # and all remaining timeouts to 10 seconds.
1106
+ # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
1107
+ # config.timeout = 10.0
1108
+ # config.rpcs.create_index.timeout = 20.0
1109
+ # end
1110
+ #
1111
+ # # Apply the above configuration only to a new client.
1112
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
1113
+ # config.timeout = 10.0
1114
+ # config.rpcs.create_index.timeout = 20.0
1115
+ # end
927
1116
  #
928
1117
  # @!attribute [rw] endpoint
929
1118
  # The hostname or hostname:port of the service endpoint.
@@ -83,7 +83,7 @@ module Google
83
83
  # Create credentials
84
84
  credentials = @config.credentials
85
85
  credentials ||= Credentials.default scope: @config.scope
86
- if credentials.is_a?(String) || credentials.is_a?(Hash)
86
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
87
87
  credentials = Credentials.new credentials, scope: @config.scope
88
88
  end
89
89
  @quota_project_id = @config.quota_project
@@ -144,6 +144,27 @@ module Google
144
144
  #
145
145
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
146
146
  #
147
+ # @example Basic example
148
+ # require "google/longrunning"
149
+ #
150
+ # # Create a client object. The client can be reused for multiple calls.
151
+ # client = Google::Longrunning::Operations::Client.new
152
+ #
153
+ # # Create a request. To set request fields, pass in keyword arguments.
154
+ # request = Google::Longrunning::ListOperationsRequest.new
155
+ #
156
+ # # Call the list_operations method.
157
+ # result = client.list_operations request
158
+ #
159
+ # # The returned object is of type Gapic::PagedEnumerable. You can
160
+ # # iterate over all elements by calling #each, and the enumerable
161
+ # # will lazily make API calls to fetch subsequent pages. Other
162
+ # # methods are also available for managing paging directly.
163
+ # result.each do |response|
164
+ # # Each element is of type ::Google::Longrunning::Operation.
165
+ # p response
166
+ # end
167
+ #
147
168
  def list_operations request, options = nil
148
169
  raise ::ArgumentError, "request must be provided" if request.nil?
149
170
 
@@ -161,16 +182,20 @@ module Google
161
182
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
162
183
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
163
184
 
164
- header_params = {
165
- "name" => request.name
166
- }
185
+ header_params = {}
186
+ if request.name
187
+ header_params["name"] = request.name
188
+ end
189
+
167
190
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
168
191
  metadata[:"x-goog-request-params"] ||= request_params_header
169
192
 
170
193
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
171
194
  metadata: metadata,
172
195
  retry_policy: @config.rpcs.list_operations.retry_policy
173
- options.apply_defaults metadata: @config.metadata,
196
+
197
+ options.apply_defaults timeout: @config.timeout,
198
+ metadata: @config.metadata,
174
199
  retry_policy: @config.retry_policy
175
200
 
176
201
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -214,6 +239,28 @@ module Google
214
239
  #
215
240
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
216
241
  #
242
+ # @example Basic example
243
+ # require "google/longrunning"
244
+ #
245
+ # # Create a client object. The client can be reused for multiple calls.
246
+ # client = Google::Longrunning::Operations::Client.new
247
+ #
248
+ # # Create a request. To set request fields, pass in keyword arguments.
249
+ # request = Google::Longrunning::GetOperationRequest.new
250
+ #
251
+ # # Call the get_operation method.
252
+ # result = client.get_operation request
253
+ #
254
+ # # The returned object is of type Gapic::Operation. You can use this
255
+ # # object to check the status of an operation, cancel it, or wait
256
+ # # for results. Here is how to block until completion:
257
+ # result.wait_until_done! timeout: 60
258
+ # if result.response?
259
+ # p result.response
260
+ # else
261
+ # puts "Error!"
262
+ # end
263
+ #
217
264
  def get_operation request, options = nil
218
265
  raise ::ArgumentError, "request must be provided" if request.nil?
219
266
 
@@ -231,16 +278,20 @@ module Google
231
278
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
232
279
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
233
280
 
234
- header_params = {
235
- "name" => request.name
236
- }
281
+ header_params = {}
282
+ if request.name
283
+ header_params["name"] = request.name
284
+ end
285
+
237
286
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
238
287
  metadata[:"x-goog-request-params"] ||= request_params_header
239
288
 
240
289
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
241
290
  metadata: metadata,
242
291
  retry_policy: @config.rpcs.get_operation.retry_policy
243
- options.apply_defaults metadata: @config.metadata,
292
+
293
+ options.apply_defaults timeout: @config.timeout,
294
+ metadata: @config.metadata,
244
295
  retry_policy: @config.retry_policy
245
296
 
246
297
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -284,6 +335,21 @@ module Google
284
335
  #
285
336
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
286
337
  #
338
+ # @example Basic example
339
+ # require "google/longrunning"
340
+ #
341
+ # # Create a client object. The client can be reused for multiple calls.
342
+ # client = Google::Longrunning::Operations::Client.new
343
+ #
344
+ # # Create a request. To set request fields, pass in keyword arguments.
345
+ # request = Google::Longrunning::DeleteOperationRequest.new
346
+ #
347
+ # # Call the delete_operation method.
348
+ # result = client.delete_operation request
349
+ #
350
+ # # The returned object is of type Google::Protobuf::Empty.
351
+ # p result
352
+ #
287
353
  def delete_operation request, options = nil
288
354
  raise ::ArgumentError, "request must be provided" if request.nil?
289
355
 
@@ -301,16 +367,20 @@ module Google
301
367
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
302
368
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
303
369
 
304
- header_params = {
305
- "name" => request.name
306
- }
370
+ header_params = {}
371
+ if request.name
372
+ header_params["name"] = request.name
373
+ end
374
+
307
375
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
308
376
  metadata[:"x-goog-request-params"] ||= request_params_header
309
377
 
310
378
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
311
379
  metadata: metadata,
312
380
  retry_policy: @config.rpcs.delete_operation.retry_policy
313
- options.apply_defaults metadata: @config.metadata,
381
+
382
+ options.apply_defaults timeout: @config.timeout,
383
+ metadata: @config.metadata,
314
384
  retry_policy: @config.retry_policy
315
385
 
316
386
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -359,6 +429,21 @@ module Google
359
429
  #
360
430
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
361
431
  #
432
+ # @example Basic example
433
+ # require "google/longrunning"
434
+ #
435
+ # # Create a client object. The client can be reused for multiple calls.
436
+ # client = Google::Longrunning::Operations::Client.new
437
+ #
438
+ # # Create a request. To set request fields, pass in keyword arguments.
439
+ # request = Google::Longrunning::CancelOperationRequest.new
440
+ #
441
+ # # Call the cancel_operation method.
442
+ # result = client.cancel_operation request
443
+ #
444
+ # # The returned object is of type Google::Protobuf::Empty.
445
+ # p result
446
+ #
362
447
  def cancel_operation request, options = nil
363
448
  raise ::ArgumentError, "request must be provided" if request.nil?
364
449
 
@@ -376,16 +461,20 @@ module Google
376
461
  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
377
462
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
378
463
 
379
- header_params = {
380
- "name" => request.name
381
- }
464
+ header_params = {}
465
+ if request.name
466
+ header_params["name"] = request.name
467
+ end
468
+
382
469
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
383
470
  metadata[:"x-goog-request-params"] ||= request_params_header
384
471
 
385
472
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
386
473
  metadata: metadata,
387
474
  retry_policy: @config.rpcs.cancel_operation.retry_policy
388
- options.apply_defaults metadata: @config.metadata,
475
+
476
+ options.apply_defaults timeout: @config.timeout,
477
+ metadata: @config.metadata,
389
478
  retry_policy: @config.retry_policy
390
479
 
391
480
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -397,9 +486,9 @@ module Google
397
486
  end
398
487
 
399
488
  ##
400
- # Waits for the specified long-running operation until it is done or reaches
401
- # at most a specified timeout, returning the latest state. If the operation
402
- # is already done, the latest state is immediately returned. If the timeout
489
+ # Waits until the specified long-running operation is done or reaches at most
490
+ # a specified timeout, returning the latest state. If the operation is
491
+ # already done, the latest state is immediately returned. If the timeout
403
492
  # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
404
493
  # timeout is used. If the server does not support this method, it returns
405
494
  # `google.rpc.Code.UNIMPLEMENTED`.
@@ -437,6 +526,28 @@ module Google
437
526
  #
438
527
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
439
528
  #
529
+ # @example Basic example
530
+ # require "google/longrunning"
531
+ #
532
+ # # Create a client object. The client can be reused for multiple calls.
533
+ # client = Google::Longrunning::Operations::Client.new
534
+ #
535
+ # # Create a request. To set request fields, pass in keyword arguments.
536
+ # request = Google::Longrunning::WaitOperationRequest.new
537
+ #
538
+ # # Call the wait_operation method.
539
+ # result = client.wait_operation request
540
+ #
541
+ # # The returned object is of type Gapic::Operation. You can use this
542
+ # # object to check the status of an operation, cancel it, or wait
543
+ # # for results. Here is how to block until completion:
544
+ # result.wait_until_done! timeout: 60
545
+ # if result.response?
546
+ # p result.response
547
+ # else
548
+ # puts "Error!"
549
+ # end
550
+ #
440
551
  def wait_operation request, options = nil
441
552
  raise ::ArgumentError, "request must be provided" if request.nil?
442
553
 
@@ -457,7 +568,9 @@ module Google
457
568
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
458
569
  metadata: metadata,
459
570
  retry_policy: @config.rpcs.wait_operation.retry_policy
460
- options.apply_defaults metadata: @config.metadata,
571
+
572
+ options.apply_defaults timeout: @config.timeout,
573
+ metadata: @config.metadata,
461
574
  retry_policy: @config.retry_policy
462
575
 
463
576
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -482,22 +595,21 @@ module Google
482
595
  # Configuration can be applied globally to all clients, or to a single client
483
596
  # on construction.
484
597
  #
485
- # # Examples
486
- #
487
- # To modify the global config, setting the timeout for list_operations
488
- # to 20 seconds, and all remaining timeouts to 10 seconds:
489
- #
490
- # ::Google::Longrunning::Operations::Client.configure do |config|
491
- # config.timeout = 10.0
492
- # config.rpcs.list_operations.timeout = 20.0
493
- # end
494
- #
495
- # To apply the above configuration only to a new client:
496
- #
497
- # client = ::Google::Longrunning::Operations::Client.new do |config|
498
- # config.timeout = 10.0
499
- # config.rpcs.list_operations.timeout = 20.0
500
- # end
598
+ # @example
599
+ #
600
+ # # Modify the global config, setting the timeout for
601
+ # # list_operations to 20 seconds,
602
+ # # and all remaining timeouts to 10 seconds.
603
+ # ::Google::Longrunning::Operations::Client.configure do |config|
604
+ # config.timeout = 10.0
605
+ # config.rpcs.list_operations.timeout = 20.0
606
+ # end
607
+ #
608
+ # # Apply the above configuration only to a new client.
609
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
610
+ # config.timeout = 10.0
611
+ # config.rpcs.list_operations.timeout = 20.0
612
+ # end
501
613
  #
502
614
  # @!attribute [rw] endpoint
503
615
  # The hostname or hostname:port of the service endpoint.
@@ -22,7 +22,7 @@ module Google
22
22
  module Firestore
23
23
  module Admin
24
24
  module V1
25
- VERSION = "0.3.1"
25
+ VERSION = "0.3.5"
26
26
  end
27
27
  end
28
28
  end
@@ -1,11 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/admin/v1/field.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/resource_pb'
7
5
  require 'google/firestore/admin/v1/index_pb'
8
6
  require 'google/api/annotations_pb'
7
+ require 'google/protobuf'
8
+
9
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
10
  add_file("google/firestore/admin/v1/field.proto", :syntax => :proto3) do
11
11
  add_message "google.firestore.admin.v1.Field" do
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/admin/v1/firestore_admin.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
@@ -12,6 +10,8 @@ require 'google/firestore/admin/v1/index_pb'
12
10
  require 'google/longrunning/operations_pb'
13
11
  require 'google/protobuf/empty_pb'
14
12
  require 'google/protobuf/field_mask_pb'
13
+ require 'google/protobuf'
14
+
15
15
  Google::Protobuf::DescriptorPool.generated_pool.build do
16
16
  add_file("google/firestore/admin/v1/firestore_admin.proto", :syntax => :proto3) do
17
17
  add_message "google.firestore.admin.v1.CreateIndexRequest" do
@@ -1,10 +1,10 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/admin/v1/index.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/resource_pb'
7
5
  require 'google/api/annotations_pb'
6
+ require 'google/protobuf'
7
+
8
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
9
9
  add_file("google/firestore/admin/v1/index.proto", :syntax => :proto3) do
10
10
  add_message "google.firestore.admin.v1.Index" do
@@ -1,10 +1,10 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/admin/v1/location.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/type/latlng_pb'
7
5
  require 'google/api/annotations_pb'
6
+ require 'google/protobuf'
7
+
8
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
9
9
  add_file("google/firestore/admin/v1/location.proto", :syntax => :proto3) do
10
10
  add_message "google.firestore.admin.v1.LocationMetadata" do
@@ -1,11 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/firestore/admin/v1/operation.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/firestore/admin/v1/index_pb'
7
5
  require 'google/protobuf/timestamp_pb'
8
6
  require 'google/api/annotations_pb'
7
+ require 'google/protobuf'
8
+
9
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
10
  add_file("google/firestore/admin/v1/operation.proto", :syntax => :proto3) do
11
11
  add_message "google.firestore.admin.v1.IndexOperationMetadata" do
@@ -57,9 +57,15 @@ module Google
57
57
 
58
58
  # Denotes that a (repeated) field is an unordered list.
59
59
  # This indicates that the service may provide the elements of the list
60
- # in any arbitrary order, rather than the order the user originally
60
+ # in any arbitrary order, rather than the order the user originally
61
61
  # provided. Additionally, the list's order may or may not be stable.
62
62
  UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
63
69
  end
64
70
  end
65
71
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-admin-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-06-17 00:00:00.000000000 Z
11
+ date: 2021-11-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.5'
19
+ version: '0.7'
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.5'
29
+ version: '0.7'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -159,8 +159,7 @@ dependencies:
159
159
  description: Cloud Firestore is a NoSQL document database built for automatic scaling,
160
160
  high performance, and ease of application development. Note that google-cloud-firestore-admin-v1
161
161
  is a version-specific client library. For most uses, we recommend installing the
162
- main client library google-cloud-firestore-admin instead. See the readme for more
163
- details.
162
+ main client library google-cloud-firestore instead. See the readme for more details.
164
163
  email: googleapis-packages@google.com
165
164
  executables: []
166
165
  extensions: []