google-cloud-firestore-admin-v1 0.3.2 → 0.3.3

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 (5) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +56 -45
  3. data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +30 -21
  4. data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
  5. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e2a7202dfcfdc2bbc41555675fc84fa7fd07e728d578b87d638517c8cb10c3a9
4
- data.tar.gz: aeefe07ec3f69b4971328f1a9afe985008d64f505fb622a917b817e5d068d02d
3
+ metadata.gz: 811771792ab77e7740746b25d753ca630f44501b2a93a018d898500e291a2086
4
+ data.tar.gz: 9dbe0031231fe01eecbc2ebfcdfb3908680384b8c6231139d06b67a5766e2934
5
5
  SHA512:
6
- metadata.gz: 99f3d268f305ef00c1270018c25ffac70529cff29d6c309aa1cd14cf1665ba8baf3dc61923d5ed273179376e7e5af97f2a5435d6912dd07cfae29c44a2db9e91
7
- data.tar.gz: 92dc46b72e71908b8b28bcb15f503e38b7919d0147cea5636b3917e9f406ca18eed740cb4c31cf4e77c9336c357eec034ab9ba329d248b6378e2174a07dd122e
6
+ metadata.gz: 1406b238c2dea98ee2f76747d40ab579e3e88bd01a64d169b591a58da60545af0b8bf7ea663fa5660d99c77c731ff0ac7af8cdbfde5bc9dbf76d79ea8958648a
7
+ data.tar.gz: 5b76876967602556bba577bac971ad539b46ca43bcf9750bb382a97d0a7c3574663e3568c5b8c12147b417d272a8aa7e4cd734c44c1c57997c0eec609790a7c8
data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb CHANGED
@@ -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]
@@ -129,19 +128,15 @@ module Google
129
128
  ##
130
129
  # Create a new FirestoreAdmin client object.
131
130
  #
132
- # ## Examples
133
- #
134
- # To create a new FirestoreAdmin client with the default
135
- # configuration:
131
+ # @example
136
132
  #
137
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
133
+ # # Create a client using the default configuration
134
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
138
135
  #
139
- # To create a new FirestoreAdmin client with a custom
140
- # configuration:
141
- #
142
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
143
- # config.timeout = 10.0
144
- # 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
145
140
  #
146
141
  # @yield [config] Configure the FirestoreAdmin client.
147
142
  # @yieldparam config [Client::Configuration]
@@ -161,10 +156,9 @@ module Google
161
156
 
162
157
  # Create credentials
163
158
  credentials = @config.credentials
164
- # 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,
165
160
  # but only if the default endpoint does not have a region prefix.
166
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
167
- @config.endpoint == Client.configure.endpoint &&
161
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
168
162
  !@config.endpoint.split(".").first.include?("-")
169
163
  credentials ||= Credentials.default scope: @config.scope,
170
164
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -257,7 +251,9 @@ module Google
257
251
  options.apply_defaults timeout: @config.rpcs.create_index.timeout,
258
252
  metadata: metadata,
259
253
  retry_policy: @config.rpcs.create_index.retry_policy
260
- options.apply_defaults metadata: @config.metadata,
254
+
255
+ options.apply_defaults timeout: @config.timeout,
256
+ metadata: @config.metadata,
261
257
  retry_policy: @config.retry_policy
262
258
 
263
259
  @firestore_admin_stub.call_rpc :create_index, request, options: options do |response, operation|
@@ -333,7 +329,9 @@ module Google
333
329
  options.apply_defaults timeout: @config.rpcs.list_indexes.timeout,
334
330
  metadata: metadata,
335
331
  retry_policy: @config.rpcs.list_indexes.retry_policy
336
- options.apply_defaults metadata: @config.metadata,
332
+
333
+ options.apply_defaults timeout: @config.timeout,
334
+ metadata: @config.metadata,
337
335
  retry_policy: @config.retry_policy
338
336
 
339
337
  @firestore_admin_stub.call_rpc :list_indexes, request, options: options do |response, operation|
@@ -401,7 +399,9 @@ module Google
401
399
  options.apply_defaults timeout: @config.rpcs.get_index.timeout,
402
400
  metadata: metadata,
403
401
  retry_policy: @config.rpcs.get_index.retry_policy
404
- options.apply_defaults metadata: @config.metadata,
402
+
403
+ options.apply_defaults timeout: @config.timeout,
404
+ metadata: @config.metadata,
405
405
  retry_policy: @config.retry_policy
406
406
 
407
407
  @firestore_admin_stub.call_rpc :get_index, request, options: options do |response, operation|
@@ -468,7 +468,9 @@ module Google
468
468
  options.apply_defaults timeout: @config.rpcs.delete_index.timeout,
469
469
  metadata: metadata,
470
470
  retry_policy: @config.rpcs.delete_index.retry_policy
471
- options.apply_defaults metadata: @config.metadata,
471
+
472
+ options.apply_defaults timeout: @config.timeout,
473
+ metadata: @config.metadata,
472
474
  retry_policy: @config.retry_policy
473
475
 
474
476
  @firestore_admin_stub.call_rpc :delete_index, request, options: options do |response, operation|
@@ -535,7 +537,9 @@ module Google
535
537
  options.apply_defaults timeout: @config.rpcs.get_field.timeout,
536
538
  metadata: metadata,
537
539
  retry_policy: @config.rpcs.get_field.retry_policy
538
- options.apply_defaults metadata: @config.metadata,
540
+
541
+ options.apply_defaults timeout: @config.timeout,
542
+ metadata: @config.metadata,
539
543
  retry_policy: @config.retry_policy
540
544
 
541
545
  @firestore_admin_stub.call_rpc :get_field, request, options: options do |response, operation|
@@ -616,7 +620,9 @@ module Google
616
620
  options.apply_defaults timeout: @config.rpcs.update_field.timeout,
617
621
  metadata: metadata,
618
622
  retry_policy: @config.rpcs.update_field.retry_policy
619
- options.apply_defaults metadata: @config.metadata,
623
+
624
+ options.apply_defaults timeout: @config.timeout,
625
+ metadata: @config.metadata,
620
626
  retry_policy: @config.retry_policy
621
627
 
622
628
  @firestore_admin_stub.call_rpc :update_field, request, options: options do |response, operation|
@@ -701,7 +707,9 @@ module Google
701
707
  options.apply_defaults timeout: @config.rpcs.list_fields.timeout,
702
708
  metadata: metadata,
703
709
  retry_policy: @config.rpcs.list_fields.retry_policy
704
- options.apply_defaults metadata: @config.metadata,
710
+
711
+ options.apply_defaults timeout: @config.timeout,
712
+ metadata: @config.metadata,
705
713
  retry_policy: @config.retry_policy
706
714
 
707
715
  @firestore_admin_stub.call_rpc :list_fields, request, options: options do |response, operation|
@@ -787,7 +795,9 @@ module Google
787
795
  options.apply_defaults timeout: @config.rpcs.export_documents.timeout,
788
796
  metadata: metadata,
789
797
  retry_policy: @config.rpcs.export_documents.retry_policy
790
- options.apply_defaults metadata: @config.metadata,
798
+
799
+ options.apply_defaults timeout: @config.timeout,
800
+ metadata: @config.metadata,
791
801
  retry_policy: @config.retry_policy
792
802
 
793
803
  @firestore_admin_stub.call_rpc :export_documents, request, options: options do |response, operation|
@@ -868,7 +878,9 @@ module Google
868
878
  options.apply_defaults timeout: @config.rpcs.import_documents.timeout,
869
879
  metadata: metadata,
870
880
  retry_policy: @config.rpcs.import_documents.retry_policy
871
- options.apply_defaults metadata: @config.metadata,
881
+
882
+ options.apply_defaults timeout: @config.timeout,
883
+ metadata: @config.metadata,
872
884
  retry_policy: @config.retry_policy
873
885
 
874
886
  @firestore_admin_stub.call_rpc :import_documents, request, options: options do |response, operation|
@@ -893,22 +905,21 @@ module Google
893
905
  # Configuration can be applied globally to all clients, or to a single client
894
906
  # on construction.
895
907
  #
896
- # # Examples
897
- #
898
- # To modify the global config, setting the timeout for create_index
899
- # to 20 seconds, and all remaining timeouts to 10 seconds:
900
- #
901
- # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
902
- # config.timeout = 10.0
903
- # config.rpcs.create_index.timeout = 20.0
904
- # end
905
- #
906
- # To apply the above configuration only to a new client:
907
- #
908
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
909
- # config.timeout = 10.0
910
- # config.rpcs.create_index.timeout = 20.0
911
- # end
908
+ # @example
909
+ #
910
+ # # Modify the global config, setting the timeout for
911
+ # # create_index to 20 seconds,
912
+ # # and all remaining timeouts to 10 seconds.
913
+ # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
914
+ # config.timeout = 10.0
915
+ # config.rpcs.create_index.timeout = 20.0
916
+ # end
917
+ #
918
+ # # Apply the above configuration only to a new client.
919
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
920
+ # config.timeout = 10.0
921
+ # config.rpcs.create_index.timeout = 20.0
922
+ # end
912
923
  #
913
924
  # @!attribute [rw] endpoint
914
925
  # The hostname or hostname:port of the service endpoint.
data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb CHANGED
@@ -170,7 +170,9 @@ module Google
170
170
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
171
171
  metadata: metadata,
172
172
  retry_policy: @config.rpcs.list_operations.retry_policy
173
- options.apply_defaults metadata: @config.metadata,
173
+
174
+ options.apply_defaults timeout: @config.timeout,
175
+ metadata: @config.metadata,
174
176
  retry_policy: @config.retry_policy
175
177
 
176
178
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -240,7 +242,9 @@ module Google
240
242
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
241
243
  metadata: metadata,
242
244
  retry_policy: @config.rpcs.get_operation.retry_policy
243
- options.apply_defaults metadata: @config.metadata,
245
+
246
+ options.apply_defaults timeout: @config.timeout,
247
+ metadata: @config.metadata,
244
248
  retry_policy: @config.retry_policy
245
249
 
246
250
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -310,7 +314,9 @@ module Google
310
314
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
311
315
  metadata: metadata,
312
316
  retry_policy: @config.rpcs.delete_operation.retry_policy
313
- options.apply_defaults metadata: @config.metadata,
317
+
318
+ options.apply_defaults timeout: @config.timeout,
319
+ metadata: @config.metadata,
314
320
  retry_policy: @config.retry_policy
315
321
 
316
322
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -385,7 +391,9 @@ module Google
385
391
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
386
392
  metadata: metadata,
387
393
  retry_policy: @config.rpcs.cancel_operation.retry_policy
388
- options.apply_defaults metadata: @config.metadata,
394
+
395
+ options.apply_defaults timeout: @config.timeout,
396
+ metadata: @config.metadata,
389
397
  retry_policy: @config.retry_policy
390
398
 
391
399
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -457,7 +465,9 @@ module Google
457
465
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
458
466
  metadata: metadata,
459
467
  retry_policy: @config.rpcs.wait_operation.retry_policy
460
- options.apply_defaults metadata: @config.metadata,
468
+
469
+ options.apply_defaults timeout: @config.timeout,
470
+ metadata: @config.metadata,
461
471
  retry_policy: @config.retry_policy
462
472
 
463
473
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -482,22 +492,21 @@ module Google
482
492
  # Configuration can be applied globally to all clients, or to a single client
483
493
  # on construction.
484
494
  #
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
495
+ # @example
496
+ #
497
+ # # Modify the global config, setting the timeout for
498
+ # # list_operations to 20 seconds,
499
+ # # and all remaining timeouts to 10 seconds.
500
+ # ::Google::Longrunning::Operations::Client.configure do |config|
501
+ # config.timeout = 10.0
502
+ # config.rpcs.list_operations.timeout = 20.0
503
+ # end
504
+ #
505
+ # # Apply the above configuration only to a new client.
506
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
507
+ # config.timeout = 10.0
508
+ # config.rpcs.list_operations.timeout = 20.0
509
+ # end
501
510
  #
502
511
  # @!attribute [rw] endpoint
503
512
  # The hostname or hostname:port of the service endpoint.
data/lib/google/cloud/firestore/admin/v1/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Firestore
23
23
  module Admin
24
24
  module V1
25
- VERSION = "0.3.2"
25
+ VERSION = "0.3.3"
26
26
  end
27
27
  end
28
28
  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.2
4
+ version: 0.3.3
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-07-12 00:00:00.000000000 Z
11
+ date: 2021-08-11 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