google-cloud-redis-v1beta1 0.4.0 → 0.4.4

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: 35bdbf5cbd339aa7f930e974e5512d10b905b3f8a92bf08fcd37250095baf02c
4
- data.tar.gz: 8de2f4c0bc728221e19ed91885f4e9bc0e029ba0f21d63cec171e792c359c2c3
3
+ metadata.gz: 6e12e7634080ac529236383495c9737b8f8482e239eb4206939a6ecad6727e51
4
+ data.tar.gz: e191a618b8521b268ecebe4eb6e78a6eb351690b7332ff03013008cf819e7ef6
5
5
  SHA512:
6
- metadata.gz: 2aacec360a9abd839853f727e84dccaaa180785cf17a402d561a1296d6becb8c418accdb05824d70ea8135493de90b86815e0d95e36a3c8f613bfa659594b2b8
7
- data.tar.gz: 28c5a67bd5dab93a4723c8cfe8a75c5a1d1002043f751e7843ea94642705b36df803e68d216713bdbcd78bef70d8a054455c5909dd75ac2afa19dad9f4248c87
6
+ metadata.gz: 7d196c0aadc2888794b9de4f3b497e43b88477aa683c091c4e673bb175c1c5d90fc912979b6d79916155f66aa539896af1b672d2d748027efc7fc8d88670e2db
7
+ data.tar.gz: e9c8f5c897b555a05d24b4428994af2e9c74c75a37a65453e3dac5ae415d45c6cf7bb4176b583a50ed56895e939ac51396baeb1185fd63ac68a91b6a641ae119
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-redis-v1beta1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Redis::V1beta1::CloudRedis::Credentials}):
68
68
 
69
- 1. `REDIS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `REDIS_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
+ * `REDIS_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `REDIS_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/redis/v1beta1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Redis::V1beta1::CloudRedis::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/redis/v1beta1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new do |config|
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/redis/v1beta1"
data/README.md CHANGED
@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
33
33
  require "google/cloud/redis/v1beta1"
34
34
 
35
35
  client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Redis::V1beta1::ListInstancesRequest.new # (request fields as keyword arguments...)
37
37
  response = client.list_instances request
38
38
  ```
39
39
 
@@ -55,13 +55,12 @@ module Google
55
55
  # See {::Google::Cloud::Redis::V1beta1::CloudRedis::Client::Configuration}
56
56
  # for a description of the configuration fields.
57
57
  #
58
- # ## Example
58
+ # @example
59
59
  #
60
- # To modify the configuration for all CloudRedis clients:
61
- #
62
- # ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.configure do |config|
63
- # config.timeout = 10.0
64
- # end
60
+ # # Modify the configuration for all CloudRedis clients
61
+ # ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.configure do |config|
62
+ # config.timeout = 10.0
63
+ # end
65
64
  #
66
65
  # @yield [config] Configure the Client client.
67
66
  # @yieldparam config [Client::Configuration]
@@ -126,19 +125,15 @@ module Google
126
125
  ##
127
126
  # Create a new CloudRedis client object.
128
127
  #
129
- # ## Examples
130
- #
131
- # To create a new CloudRedis client with the default
132
- # configuration:
133
- #
134
- # client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
128
+ # @example
135
129
  #
136
- # To create a new CloudRedis client with a custom
137
- # configuration:
130
+ # # Create a client using the default configuration
131
+ # client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
138
132
  #
139
- # client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new do |config|
140
- # config.timeout = 10.0
141
- # end
133
+ # # Create a client using a custom configuration
134
+ # client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new do |config|
135
+ # config.timeout = 10.0
136
+ # end
142
137
  #
143
138
  # @yield [config] Configure the CloudRedis client.
144
139
  # @yieldparam config [Client::Configuration]
@@ -158,14 +153,13 @@ module Google
158
153
 
159
154
  # Create credentials
160
155
  credentials = @config.credentials
161
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
156
+ # Use self-signed JWT if the endpoint is unchanged from default,
162
157
  # but only if the default endpoint does not have a region prefix.
163
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
164
- @config.endpoint == Client.configure.endpoint &&
158
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
165
159
  !@config.endpoint.split(".").first.include?("-")
166
160
  credentials ||= Credentials.default scope: @config.scope,
167
161
  enable_self_signed_jwt: enable_self_signed_jwt
168
- if credentials.is_a?(String) || credentials.is_a?(Hash)
162
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
169
163
  credentials = Credentials.new credentials, scope: @config.scope
170
164
  end
171
165
  @quota_project_id = @config.quota_project
@@ -244,6 +238,27 @@ module Google
244
238
  #
245
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
246
240
  #
241
+ # @example Basic example
242
+ # require "google/cloud/redis/v1beta1"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Cloud::Redis::V1beta1::ListInstancesRequest.new
249
+ #
250
+ # # Call the list_instances method.
251
+ # result = client.list_instances request
252
+ #
253
+ # # The returned object is of type Gapic::PagedEnumerable. You can
254
+ # # iterate over all elements by calling #each, and the enumerable
255
+ # # will lazily make API calls to fetch subsequent pages. Other
256
+ # # methods are also available for managing paging directly.
257
+ # result.each do |response|
258
+ # # Each element is of type ::Google::Cloud::Redis::V1beta1::Instance.
259
+ # p response
260
+ # end
261
+ #
247
262
  def list_instances request, options = nil
248
263
  raise ::ArgumentError, "request must be provided" if request.nil?
249
264
 
@@ -261,16 +276,20 @@ module Google
261
276
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
262
277
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
263
278
 
264
- header_params = {
265
- "parent" => request.parent
266
- }
279
+ header_params = {}
280
+ if request.parent
281
+ header_params["parent"] = request.parent
282
+ end
283
+
267
284
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
268
285
  metadata[:"x-goog-request-params"] ||= request_params_header
269
286
 
270
287
  options.apply_defaults timeout: @config.rpcs.list_instances.timeout,
271
288
  metadata: metadata,
272
289
  retry_policy: @config.rpcs.list_instances.retry_policy
273
- options.apply_defaults metadata: @config.metadata,
290
+
291
+ options.apply_defaults timeout: @config.timeout,
292
+ metadata: @config.metadata,
274
293
  retry_policy: @config.retry_policy
275
294
 
276
295
  @cloud_redis_stub.call_rpc :list_instances, request, options: options do |response, operation|
@@ -313,6 +332,21 @@ module Google
313
332
  #
314
333
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
315
334
  #
335
+ # @example Basic example
336
+ # require "google/cloud/redis/v1beta1"
337
+ #
338
+ # # Create a client object. The client can be reused for multiple calls.
339
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
340
+ #
341
+ # # Create a request. To set request fields, pass in keyword arguments.
342
+ # request = Google::Cloud::Redis::V1beta1::GetInstanceRequest.new
343
+ #
344
+ # # Call the get_instance method.
345
+ # result = client.get_instance request
346
+ #
347
+ # # The returned object is of type Google::Cloud::Redis::V1beta1::Instance.
348
+ # p result
349
+ #
316
350
  def get_instance request, options = nil
317
351
  raise ::ArgumentError, "request must be provided" if request.nil?
318
352
 
@@ -330,16 +364,20 @@ module Google
330
364
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
331
365
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
332
366
 
333
- header_params = {
334
- "name" => request.name
335
- }
367
+ header_params = {}
368
+ if request.name
369
+ header_params["name"] = request.name
370
+ end
371
+
336
372
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
337
373
  metadata[:"x-goog-request-params"] ||= request_params_header
338
374
 
339
375
  options.apply_defaults timeout: @config.rpcs.get_instance.timeout,
340
376
  metadata: metadata,
341
377
  retry_policy: @config.rpcs.get_instance.retry_policy
342
- options.apply_defaults metadata: @config.metadata,
378
+
379
+ options.apply_defaults timeout: @config.timeout,
380
+ metadata: @config.metadata,
343
381
  retry_policy: @config.retry_policy
344
382
 
345
383
  @cloud_redis_stub.call_rpc :get_instance, request, options: options do |response, operation|
@@ -403,6 +441,28 @@ module Google
403
441
  #
404
442
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
405
443
  #
444
+ # @example Basic example
445
+ # require "google/cloud/redis/v1beta1"
446
+ #
447
+ # # Create a client object. The client can be reused for multiple calls.
448
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
449
+ #
450
+ # # Create a request. To set request fields, pass in keyword arguments.
451
+ # request = Google::Cloud::Redis::V1beta1::CreateInstanceRequest.new
452
+ #
453
+ # # Call the create_instance method.
454
+ # result = client.create_instance request
455
+ #
456
+ # # The returned object is of type Gapic::Operation. You can use this
457
+ # # object to check the status of an operation, cancel it, or wait
458
+ # # for results. Here is how to block until completion:
459
+ # result.wait_until_done! timeout: 60
460
+ # if result.response?
461
+ # p result.response
462
+ # else
463
+ # puts "Error!"
464
+ # end
465
+ #
406
466
  def create_instance request, options = nil
407
467
  raise ::ArgumentError, "request must be provided" if request.nil?
408
468
 
@@ -420,16 +480,20 @@ module Google
420
480
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
421
481
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
422
482
 
423
- header_params = {
424
- "parent" => request.parent
425
- }
483
+ header_params = {}
484
+ if request.parent
485
+ header_params["parent"] = request.parent
486
+ end
487
+
426
488
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
427
489
  metadata[:"x-goog-request-params"] ||= request_params_header
428
490
 
429
491
  options.apply_defaults timeout: @config.rpcs.create_instance.timeout,
430
492
  metadata: metadata,
431
493
  retry_policy: @config.rpcs.create_instance.retry_policy
432
- options.apply_defaults metadata: @config.metadata,
494
+
495
+ options.apply_defaults timeout: @config.timeout,
496
+ metadata: @config.metadata,
433
497
  retry_policy: @config.retry_policy
434
498
 
435
499
  @cloud_redis_stub.call_rpc :create_instance, request, options: options do |response, operation|
@@ -484,6 +548,28 @@ module Google
484
548
  #
485
549
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
486
550
  #
551
+ # @example Basic example
552
+ # require "google/cloud/redis/v1beta1"
553
+ #
554
+ # # Create a client object. The client can be reused for multiple calls.
555
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
556
+ #
557
+ # # Create a request. To set request fields, pass in keyword arguments.
558
+ # request = Google::Cloud::Redis::V1beta1::UpdateInstanceRequest.new
559
+ #
560
+ # # Call the update_instance method.
561
+ # result = client.update_instance request
562
+ #
563
+ # # The returned object is of type Gapic::Operation. You can use this
564
+ # # object to check the status of an operation, cancel it, or wait
565
+ # # for results. Here is how to block until completion:
566
+ # result.wait_until_done! timeout: 60
567
+ # if result.response?
568
+ # p result.response
569
+ # else
570
+ # puts "Error!"
571
+ # end
572
+ #
487
573
  def update_instance request, options = nil
488
574
  raise ::ArgumentError, "request must be provided" if request.nil?
489
575
 
@@ -501,16 +587,20 @@ module Google
501
587
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
502
588
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
503
589
 
504
- header_params = {
505
- "instance.name" => request.instance.name
506
- }
590
+ header_params = {}
591
+ if request.instance&.name
592
+ header_params["instance.name"] = request.instance.name
593
+ end
594
+
507
595
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
508
596
  metadata[:"x-goog-request-params"] ||= request_params_header
509
597
 
510
598
  options.apply_defaults timeout: @config.rpcs.update_instance.timeout,
511
599
  metadata: metadata,
512
600
  retry_policy: @config.rpcs.update_instance.retry_policy
513
- options.apply_defaults metadata: @config.metadata,
601
+
602
+ options.apply_defaults timeout: @config.timeout,
603
+ metadata: @config.metadata,
514
604
  retry_policy: @config.retry_policy
515
605
 
516
606
  @cloud_redis_stub.call_rpc :update_instance, request, options: options do |response, operation|
@@ -556,6 +646,28 @@ module Google
556
646
  #
557
647
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
558
648
  #
649
+ # @example Basic example
650
+ # require "google/cloud/redis/v1beta1"
651
+ #
652
+ # # Create a client object. The client can be reused for multiple calls.
653
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
654
+ #
655
+ # # Create a request. To set request fields, pass in keyword arguments.
656
+ # request = Google::Cloud::Redis::V1beta1::UpgradeInstanceRequest.new
657
+ #
658
+ # # Call the upgrade_instance method.
659
+ # result = client.upgrade_instance request
660
+ #
661
+ # # The returned object is of type Gapic::Operation. You can use this
662
+ # # object to check the status of an operation, cancel it, or wait
663
+ # # for results. Here is how to block until completion:
664
+ # result.wait_until_done! timeout: 60
665
+ # if result.response?
666
+ # p result.response
667
+ # else
668
+ # puts "Error!"
669
+ # end
670
+ #
559
671
  def upgrade_instance request, options = nil
560
672
  raise ::ArgumentError, "request must be provided" if request.nil?
561
673
 
@@ -573,16 +685,20 @@ module Google
573
685
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
574
686
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
575
687
 
576
- header_params = {
577
- "name" => request.name
578
- }
688
+ header_params = {}
689
+ if request.name
690
+ header_params["name"] = request.name
691
+ end
692
+
579
693
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
580
694
  metadata[:"x-goog-request-params"] ||= request_params_header
581
695
 
582
696
  options.apply_defaults timeout: @config.rpcs.upgrade_instance.timeout,
583
697
  metadata: metadata,
584
698
  retry_policy: @config.rpcs.upgrade_instance.retry_policy
585
- options.apply_defaults metadata: @config.metadata,
699
+
700
+ options.apply_defaults timeout: @config.timeout,
701
+ metadata: @config.metadata,
586
702
  retry_policy: @config.retry_policy
587
703
 
588
704
  @cloud_redis_stub.call_rpc :upgrade_instance, request, options: options do |response, operation|
@@ -634,6 +750,28 @@ module Google
634
750
  #
635
751
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
636
752
  #
753
+ # @example Basic example
754
+ # require "google/cloud/redis/v1beta1"
755
+ #
756
+ # # Create a client object. The client can be reused for multiple calls.
757
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
758
+ #
759
+ # # Create a request. To set request fields, pass in keyword arguments.
760
+ # request = Google::Cloud::Redis::V1beta1::ImportInstanceRequest.new
761
+ #
762
+ # # Call the import_instance method.
763
+ # result = client.import_instance request
764
+ #
765
+ # # The returned object is of type Gapic::Operation. You can use this
766
+ # # object to check the status of an operation, cancel it, or wait
767
+ # # for results. Here is how to block until completion:
768
+ # result.wait_until_done! timeout: 60
769
+ # if result.response?
770
+ # p result.response
771
+ # else
772
+ # puts "Error!"
773
+ # end
774
+ #
637
775
  def import_instance request, options = nil
638
776
  raise ::ArgumentError, "request must be provided" if request.nil?
639
777
 
@@ -651,16 +789,20 @@ module Google
651
789
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
652
790
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
653
791
 
654
- header_params = {
655
- "name" => request.name
656
- }
792
+ header_params = {}
793
+ if request.name
794
+ header_params["name"] = request.name
795
+ end
796
+
657
797
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
658
798
  metadata[:"x-goog-request-params"] ||= request_params_header
659
799
 
660
800
  options.apply_defaults timeout: @config.rpcs.import_instance.timeout,
661
801
  metadata: metadata,
662
802
  retry_policy: @config.rpcs.import_instance.retry_policy
663
- options.apply_defaults metadata: @config.metadata,
803
+
804
+ options.apply_defaults timeout: @config.timeout,
805
+ metadata: @config.metadata,
664
806
  retry_policy: @config.retry_policy
665
807
 
666
808
  @cloud_redis_stub.call_rpc :import_instance, request, options: options do |response, operation|
@@ -710,6 +852,28 @@ module Google
710
852
  #
711
853
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
712
854
  #
855
+ # @example Basic example
856
+ # require "google/cloud/redis/v1beta1"
857
+ #
858
+ # # Create a client object. The client can be reused for multiple calls.
859
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
860
+ #
861
+ # # Create a request. To set request fields, pass in keyword arguments.
862
+ # request = Google::Cloud::Redis::V1beta1::ExportInstanceRequest.new
863
+ #
864
+ # # Call the export_instance method.
865
+ # result = client.export_instance request
866
+ #
867
+ # # The returned object is of type Gapic::Operation. You can use this
868
+ # # object to check the status of an operation, cancel it, or wait
869
+ # # for results. Here is how to block until completion:
870
+ # result.wait_until_done! timeout: 60
871
+ # if result.response?
872
+ # p result.response
873
+ # else
874
+ # puts "Error!"
875
+ # end
876
+ #
713
877
  def export_instance request, options = nil
714
878
  raise ::ArgumentError, "request must be provided" if request.nil?
715
879
 
@@ -727,16 +891,20 @@ module Google
727
891
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
728
892
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
729
893
 
730
- header_params = {
731
- "name" => request.name
732
- }
894
+ header_params = {}
895
+ if request.name
896
+ header_params["name"] = request.name
897
+ end
898
+
733
899
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
734
900
  metadata[:"x-goog-request-params"] ||= request_params_header
735
901
 
736
902
  options.apply_defaults timeout: @config.rpcs.export_instance.timeout,
737
903
  metadata: metadata,
738
904
  retry_policy: @config.rpcs.export_instance.retry_policy
739
- options.apply_defaults metadata: @config.metadata,
905
+
906
+ options.apply_defaults timeout: @config.timeout,
907
+ metadata: @config.metadata,
740
908
  retry_policy: @config.retry_policy
741
909
 
742
910
  @cloud_redis_stub.call_rpc :export_instance, request, options: options do |response, operation|
@@ -783,6 +951,28 @@ module Google
783
951
  #
784
952
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
785
953
  #
954
+ # @example Basic example
955
+ # require "google/cloud/redis/v1beta1"
956
+ #
957
+ # # Create a client object. The client can be reused for multiple calls.
958
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
959
+ #
960
+ # # Create a request. To set request fields, pass in keyword arguments.
961
+ # request = Google::Cloud::Redis::V1beta1::FailoverInstanceRequest.new
962
+ #
963
+ # # Call the failover_instance method.
964
+ # result = client.failover_instance request
965
+ #
966
+ # # The returned object is of type Gapic::Operation. You can use this
967
+ # # object to check the status of an operation, cancel it, or wait
968
+ # # for results. Here is how to block until completion:
969
+ # result.wait_until_done! timeout: 60
970
+ # if result.response?
971
+ # p result.response
972
+ # else
973
+ # puts "Error!"
974
+ # end
975
+ #
786
976
  def failover_instance request, options = nil
787
977
  raise ::ArgumentError, "request must be provided" if request.nil?
788
978
 
@@ -800,16 +990,20 @@ module Google
800
990
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
801
991
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
802
992
 
803
- header_params = {
804
- "name" => request.name
805
- }
993
+ header_params = {}
994
+ if request.name
995
+ header_params["name"] = request.name
996
+ end
997
+
806
998
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
807
999
  metadata[:"x-goog-request-params"] ||= request_params_header
808
1000
 
809
1001
  options.apply_defaults timeout: @config.rpcs.failover_instance.timeout,
810
1002
  metadata: metadata,
811
1003
  retry_policy: @config.rpcs.failover_instance.retry_policy
812
- options.apply_defaults metadata: @config.metadata,
1004
+
1005
+ options.apply_defaults timeout: @config.timeout,
1006
+ metadata: @config.metadata,
813
1007
  retry_policy: @config.retry_policy
814
1008
 
815
1009
  @cloud_redis_stub.call_rpc :failover_instance, request, options: options do |response, operation|
@@ -853,6 +1047,28 @@ module Google
853
1047
  #
854
1048
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
855
1049
  #
1050
+ # @example Basic example
1051
+ # require "google/cloud/redis/v1beta1"
1052
+ #
1053
+ # # Create a client object. The client can be reused for multiple calls.
1054
+ # client = Google::Cloud::Redis::V1beta1::CloudRedis::Client.new
1055
+ #
1056
+ # # Create a request. To set request fields, pass in keyword arguments.
1057
+ # request = Google::Cloud::Redis::V1beta1::DeleteInstanceRequest.new
1058
+ #
1059
+ # # Call the delete_instance method.
1060
+ # result = client.delete_instance request
1061
+ #
1062
+ # # The returned object is of type Gapic::Operation. You can use this
1063
+ # # object to check the status of an operation, cancel it, or wait
1064
+ # # for results. Here is how to block until completion:
1065
+ # result.wait_until_done! timeout: 60
1066
+ # if result.response?
1067
+ # p result.response
1068
+ # else
1069
+ # puts "Error!"
1070
+ # end
1071
+ #
856
1072
  def delete_instance request, options = nil
857
1073
  raise ::ArgumentError, "request must be provided" if request.nil?
858
1074
 
@@ -870,16 +1086,20 @@ module Google
870
1086
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
871
1087
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
872
1088
 
873
- header_params = {
874
- "name" => request.name
875
- }
1089
+ header_params = {}
1090
+ if request.name
1091
+ header_params["name"] = request.name
1092
+ end
1093
+
876
1094
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
877
1095
  metadata[:"x-goog-request-params"] ||= request_params_header
878
1096
 
879
1097
  options.apply_defaults timeout: @config.rpcs.delete_instance.timeout,
880
1098
  metadata: metadata,
881
1099
  retry_policy: @config.rpcs.delete_instance.retry_policy
882
- options.apply_defaults metadata: @config.metadata,
1100
+
1101
+ options.apply_defaults timeout: @config.timeout,
1102
+ metadata: @config.metadata,
883
1103
  retry_policy: @config.retry_policy
884
1104
 
885
1105
  @cloud_redis_stub.call_rpc :delete_instance, request, options: options do |response, operation|
@@ -904,22 +1124,21 @@ module Google
904
1124
  # Configuration can be applied globally to all clients, or to a single client
905
1125
  # on construction.
906
1126
  #
907
- # # Examples
908
- #
909
- # To modify the global config, setting the timeout for list_instances
910
- # to 20 seconds, and all remaining timeouts to 10 seconds:
911
- #
912
- # ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.configure do |config|
913
- # config.timeout = 10.0
914
- # config.rpcs.list_instances.timeout = 20.0
915
- # end
916
- #
917
- # To apply the above configuration only to a new client:
918
- #
919
- # client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new do |config|
920
- # config.timeout = 10.0
921
- # config.rpcs.list_instances.timeout = 20.0
922
- # end
1127
+ # @example
1128
+ #
1129
+ # # Modify the global config, setting the timeout for
1130
+ # # list_instances to 20 seconds,
1131
+ # # and all remaining timeouts to 10 seconds.
1132
+ # ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.configure do |config|
1133
+ # config.timeout = 10.0
1134
+ # config.rpcs.list_instances.timeout = 20.0
1135
+ # end
1136
+ #
1137
+ # # Apply the above configuration only to a new client.
1138
+ # client = ::Google::Cloud::Redis::V1beta1::CloudRedis::Client.new do |config|
1139
+ # config.timeout = 10.0
1140
+ # config.rpcs.list_instances.timeout = 20.0
1141
+ # end
923
1142
  #
924
1143
  # @!attribute [rw] endpoint
925
1144
  # The hostname or hostname:port of the service endpoint.
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,16 +181,20 @@ module Google
160
181
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
169
192
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
170
193
  metadata: metadata,
171
194
  retry_policy: @config.rpcs.list_operations.retry_policy
172
- options.apply_defaults metadata: @config.metadata,
195
+
196
+ options.apply_defaults timeout: @config.timeout,
197
+ metadata: @config.metadata,
173
198
  retry_policy: @config.retry_policy
174
199
 
175
200
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -213,6 +238,28 @@ module Google
213
238
  #
214
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
215
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
216
263
  def get_operation request, options = nil
217
264
  raise ::ArgumentError, "request must be provided" if request.nil?
218
265
 
@@ -230,16 +277,20 @@ module Google
230
277
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
231
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
232
279
 
233
- header_params = {
234
- "name" => request.name
235
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
236
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
237
286
  metadata[:"x-goog-request-params"] ||= request_params_header
238
287
 
239
288
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
240
289
  metadata: metadata,
241
290
  retry_policy: @config.rpcs.get_operation.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
291
+
292
+ options.apply_defaults timeout: @config.timeout,
293
+ metadata: @config.metadata,
243
294
  retry_policy: @config.retry_policy
244
295
 
245
296
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -283,6 +334,21 @@ module Google
283
334
  #
284
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
285
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
286
352
  def delete_operation request, options = nil
287
353
  raise ::ArgumentError, "request must be provided" if request.nil?
288
354
 
@@ -300,16 +366,20 @@ module Google
300
366
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
301
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
302
368
 
303
- header_params = {
304
- "name" => request.name
305
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
306
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
307
375
  metadata[:"x-goog-request-params"] ||= request_params_header
308
376
 
309
377
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
310
378
  metadata: metadata,
311
379
  retry_policy: @config.rpcs.delete_operation.retry_policy
312
- options.apply_defaults metadata: @config.metadata,
380
+
381
+ options.apply_defaults timeout: @config.timeout,
382
+ metadata: @config.metadata,
313
383
  retry_policy: @config.retry_policy
314
384
 
315
385
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -358,6 +428,21 @@ module Google
358
428
  #
359
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
360
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
361
446
  def cancel_operation request, options = nil
362
447
  raise ::ArgumentError, "request must be provided" if request.nil?
363
448
 
@@ -375,16 +460,20 @@ module Google
375
460
  gapic_version: ::Google::Cloud::Redis::V1beta1::VERSION
376
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
377
462
 
378
- header_params = {
379
- "name" => request.name
380
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
381
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
382
469
  metadata[:"x-goog-request-params"] ||= request_params_header
383
470
 
384
471
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
385
472
  metadata: metadata,
386
473
  retry_policy: @config.rpcs.cancel_operation.retry_policy
387
- options.apply_defaults metadata: @config.metadata,
474
+
475
+ options.apply_defaults timeout: @config.timeout,
476
+ metadata: @config.metadata,
388
477
  retry_policy: @config.retry_policy
389
478
 
390
479
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -396,9 +485,9 @@ module Google
396
485
  end
397
486
 
398
487
  ##
399
- # Waits for the specified long-running operation until it is done or reaches
400
- # at most a specified timeout, returning the latest state. If the operation
401
- # is already done, the latest state is immediately returned. If the timeout
488
+ # Waits until the specified long-running operation is done or reaches at most
489
+ # a specified timeout, returning the latest state. If the operation is
490
+ # already done, the latest state is immediately returned. If the timeout
402
491
  # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
492
  # timeout is used. If the server does not support this method, it returns
404
493
  # `google.rpc.Code.UNIMPLEMENTED`.
@@ -436,6 +525,28 @@ module Google
436
525
  #
437
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
439
550
  def wait_operation request, options = nil
440
551
  raise ::ArgumentError, "request must be provided" if request.nil?
441
552
 
@@ -456,7 +567,9 @@ module Google
456
567
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
568
  metadata: metadata,
458
569
  retry_policy: @config.rpcs.wait_operation.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
570
+
571
+ options.apply_defaults timeout: @config.timeout,
572
+ metadata: @config.metadata,
460
573
  retry_policy: @config.retry_policy
461
574
 
462
575
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +594,21 @@ module Google
481
594
  # Configuration can be applied globally to all clients, or to a single client
482
595
  # on construction.
483
596
  #
484
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
499
- # end
597
+ # @example
598
+ #
599
+ # # Modify the global config, setting the timeout for
600
+ # # list_operations to 20 seconds,
601
+ # # and all remaining timeouts to 10 seconds.
602
+ # ::Google::Longrunning::Operations::Client.configure do |config|
603
+ # config.timeout = 10.0
604
+ # config.rpcs.list_operations.timeout = 20.0
605
+ # end
606
+ #
607
+ # # Apply the above configuration only to a new client.
608
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
609
+ # config.timeout = 10.0
610
+ # config.rpcs.list_operations.timeout = 20.0
611
+ # end
500
612
  #
501
613
  # @!attribute [rw] endpoint
502
614
  # The hostname or hostname:port of the service endpoint.
@@ -1,8 +1,6 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/redis/v1beta1/cloud_redis.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'
@@ -10,6 +8,8 @@ require 'google/api/resource_pb'
10
8
  require 'google/longrunning/operations_pb'
11
9
  require 'google/protobuf/field_mask_pb'
12
10
  require 'google/protobuf/timestamp_pb'
11
+ require 'google/protobuf'
12
+
13
13
  Google::Protobuf::DescriptorPool.generated_pool.build do
14
14
  add_file("google/cloud/redis/v1beta1/cloud_redis.proto", :syntax => :proto3) do
15
15
  add_message "google.cloud.redis.v1beta1.Instance" do
@@ -41,7 +41,7 @@ module Google
41
41
  # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
42
42
  class Service
43
43
 
44
- include GRPC::GenericService
44
+ include ::GRPC::GenericService
45
45
 
46
46
  self.marshal_class_method = :encode
47
47
  self.unmarshal_class_method = :decode
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Redis
23
23
  module V1beta1
24
- VERSION = "0.4.0"
24
+ VERSION = "0.4.4"
25
25
  end
26
26
  end
27
27
  end
@@ -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,29 +1,35 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-redis-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.4.4
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-03-09 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
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0.7'
20
+ - - "<"
18
21
  - !ruby/object:Gem::Version
19
- version: '0.3'
22
+ version: 2.a
20
23
  type: :runtime
21
24
  prerelease: false
22
25
  version_requirements: !ruby/object:Gem::Requirement
23
26
  requirements:
24
- - - "~>"
27
+ - - ">="
28
+ - !ruby/object:Gem::Version
29
+ version: '0.7'
30
+ - - "<"
25
31
  - !ruby/object:Gem::Version
26
- version: '0.3'
32
+ version: 2.a
27
33
  - !ruby/object:Gem::Dependency
28
34
  name: google-cloud-errors
29
35
  requirement: !ruby/object:Gem::Requirement
@@ -203,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
203
209
  - !ruby/object:Gem::Version
204
210
  version: '0'
205
211
  requirements: []
206
- rubygems_version: 3.2.13
212
+ rubygems_version: 3.2.17
207
213
  signing_key:
208
214
  specification_version: 4
209
215
  summary: API Client library for the Google Cloud Memorystore for Redis V1beta1 API