google-cloud-memcache-v1 0.2.0 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 55525b9dc045b64448bacadfbfbff579b89de70daebcca2bdd4ada7241efcbe4
4
- data.tar.gz: ae7a8f57cd7bc6323ed4472be7ef1c854fb924a01cdd17b39c8f18ab5de4a537
3
+ metadata.gz: c49537e554b9e8f14fa7bccf304991eb79aeaa580f539b0a29ff8c4c628e3bc5
4
+ data.tar.gz: b89877a50222ceef7e5d4f8e8982e830a7140137326a4efa61e1575a8a9442d0
5
5
  SHA512:
6
- metadata.gz: 6fd9f25a1d4e86f2b66558b70d63e6b94241c45829da341d16421c80c6bfc436a139e88c8fdab78c12e24b5054218fc6abb5b5b9f9ffbeccd628ce83e6eb17fb
7
- data.tar.gz: 051b3dcec6d6bd0f37239e8865dcf65b749c71d28966edf25190aacff07e75b407465d8f54c999eb5cb5d5b6a348597f78fd7777e9bbf001d2ac78d5f53189c0
6
+ metadata.gz: c654a50bdcf049c1703d869179e540e08a53467380b9040bd909d612a3c41bd8406d6f98e2efa8e19e9fe8f2018141159021c5ea3a3e73b68996a67983aa3ba8
7
+ data.tar.gz: e9737749b4ed28729c450892da6da565297ff1dcc36e9be1f3cca2fafb473932c79d8cd6b69205c6997519b190a5a2a0b92e01bb8e21535e48e19bdd2167316f
data/AUTHENTICATION.md CHANGED
@@ -66,11 +66,11 @@ The environment variables that google-cloud-memcache-v1
66
66
  checks for credentials are configured on the service Credentials class (such as
67
67
  {::Google::Cloud::Memcache::V1::CloudMemcache::Credentials}):
68
68
 
69
- 1. `MEMCACHE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- 2. `MEMCACHE_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
+ * `MEMCACHE_CREDENTIALS` - Path to JSON file, or JSON contents
70
+ * `MEMCACHE_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/memcache/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Memcache::V1::CloudMemcache::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/memcache/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Memcache::V1::CloudMemcache::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/memcache/v1"
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/memcache/v1"
34
34
 
35
35
  client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new
36
- request = my_create_request
36
+ request = ::Google::Cloud::Memcache::V1::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::Memcache::V1::CloudMemcache::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 CloudMemcache clients:
61
- #
62
- # ::Google::Cloud::Memcache::V1::CloudMemcache::Client.configure do |config|
63
- # config.timeout = 10.0
64
- # end
60
+ # # Modify the configuration for all CloudMemcache clients
61
+ # ::Google::Cloud::Memcache::V1::CloudMemcache::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]
@@ -122,19 +121,15 @@ module Google
122
121
  ##
123
122
  # Create a new CloudMemcache client object.
124
123
  #
125
- # ## Examples
126
- #
127
- # To create a new CloudMemcache client with the default
128
- # configuration:
124
+ # @example
129
125
  #
130
- # client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new
126
+ # # Create a client using the default configuration
127
+ # client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new
131
128
  #
132
- # To create a new CloudMemcache client with a custom
133
- # configuration:
134
- #
135
- # client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new do |config|
136
- # config.timeout = 10.0
137
- # end
129
+ # # Create a client using a custom configuration
130
+ # client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new do |config|
131
+ # config.timeout = 10.0
132
+ # end
138
133
  #
139
134
  # @yield [config] Configure the CloudMemcache client.
140
135
  # @yieldparam config [Client::Configuration]
@@ -154,14 +149,13 @@ module Google
154
149
 
155
150
  # Create credentials
156
151
  credentials = @config.credentials
157
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
152
+ # Use self-signed JWT if the endpoint is unchanged from default,
158
153
  # but only if the default endpoint does not have a region prefix.
159
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
160
- @config.endpoint == Client.configure.endpoint &&
154
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
161
155
  !@config.endpoint.split(".").first.include?("-")
162
156
  credentials ||= Credentials.default scope: @config.scope,
163
157
  enable_self_signed_jwt: enable_self_signed_jwt
164
- if credentials.is_a?(String) || credentials.is_a?(Hash)
158
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
165
159
  credentials = Credentials.new credentials, scope: @config.scope
166
160
  end
167
161
  @quota_project_id = @config.quota_project
@@ -237,6 +231,27 @@ module Google
237
231
  #
238
232
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
239
233
  #
234
+ # @example Basic example
235
+ # require "google/cloud/memcache/v1"
236
+ #
237
+ # # Create a client object. The client can be reused for multiple calls.
238
+ # client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
239
+ #
240
+ # # Create a request. To set request fields, pass in keyword arguments.
241
+ # request = Google::Cloud::Memcache::V1::ListInstancesRequest.new
242
+ #
243
+ # # Call the list_instances method.
244
+ # result = client.list_instances request
245
+ #
246
+ # # The returned object is of type Gapic::PagedEnumerable. You can
247
+ # # iterate over all elements by calling #each, and the enumerable
248
+ # # will lazily make API calls to fetch subsequent pages. Other
249
+ # # methods are also available for managing paging directly.
250
+ # result.each do |response|
251
+ # # Each element is of type ::Google::Cloud::Memcache::V1::Instance.
252
+ # p response
253
+ # end
254
+ #
240
255
  def list_instances request, options = nil
241
256
  raise ::ArgumentError, "request must be provided" if request.nil?
242
257
 
@@ -254,16 +269,20 @@ module Google
254
269
  gapic_version: ::Google::Cloud::Memcache::V1::VERSION
255
270
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
256
271
 
257
- header_params = {
258
- "parent" => request.parent
259
- }
272
+ header_params = {}
273
+ if request.parent
274
+ header_params["parent"] = request.parent
275
+ end
276
+
260
277
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
261
278
  metadata[:"x-goog-request-params"] ||= request_params_header
262
279
 
263
280
  options.apply_defaults timeout: @config.rpcs.list_instances.timeout,
264
281
  metadata: metadata,
265
282
  retry_policy: @config.rpcs.list_instances.retry_policy
266
- options.apply_defaults metadata: @config.metadata,
283
+
284
+ options.apply_defaults timeout: @config.timeout,
285
+ metadata: @config.metadata,
267
286
  retry_policy: @config.retry_policy
268
287
 
269
288
  @cloud_memcache_stub.call_rpc :list_instances, request, options: options do |response, operation|
@@ -306,6 +325,21 @@ module Google
306
325
  #
307
326
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
308
327
  #
328
+ # @example Basic example
329
+ # require "google/cloud/memcache/v1"
330
+ #
331
+ # # Create a client object. The client can be reused for multiple calls.
332
+ # client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
333
+ #
334
+ # # Create a request. To set request fields, pass in keyword arguments.
335
+ # request = Google::Cloud::Memcache::V1::GetInstanceRequest.new
336
+ #
337
+ # # Call the get_instance method.
338
+ # result = client.get_instance request
339
+ #
340
+ # # The returned object is of type Google::Cloud::Memcache::V1::Instance.
341
+ # p result
342
+ #
309
343
  def get_instance request, options = nil
310
344
  raise ::ArgumentError, "request must be provided" if request.nil?
311
345
 
@@ -323,16 +357,20 @@ module Google
323
357
  gapic_version: ::Google::Cloud::Memcache::V1::VERSION
324
358
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
325
359
 
326
- header_params = {
327
- "name" => request.name
328
- }
360
+ header_params = {}
361
+ if request.name
362
+ header_params["name"] = request.name
363
+ end
364
+
329
365
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
330
366
  metadata[:"x-goog-request-params"] ||= request_params_header
331
367
 
332
368
  options.apply_defaults timeout: @config.rpcs.get_instance.timeout,
333
369
  metadata: metadata,
334
370
  retry_policy: @config.rpcs.get_instance.retry_policy
335
- options.apply_defaults metadata: @config.metadata,
371
+
372
+ options.apply_defaults timeout: @config.timeout,
373
+ metadata: @config.metadata,
336
374
  retry_policy: @config.retry_policy
337
375
 
338
376
  @cloud_memcache_stub.call_rpc :get_instance, request, options: options do |response, operation|
@@ -387,6 +425,28 @@ module Google
387
425
  #
388
426
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
389
427
  #
428
+ # @example Basic example
429
+ # require "google/cloud/memcache/v1"
430
+ #
431
+ # # Create a client object. The client can be reused for multiple calls.
432
+ # client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
433
+ #
434
+ # # Create a request. To set request fields, pass in keyword arguments.
435
+ # request = Google::Cloud::Memcache::V1::CreateInstanceRequest.new
436
+ #
437
+ # # Call the create_instance method.
438
+ # result = client.create_instance request
439
+ #
440
+ # # The returned object is of type Gapic::Operation. You can use this
441
+ # # object to check the status of an operation, cancel it, or wait
442
+ # # for results. Here is how to block until completion:
443
+ # result.wait_until_done! timeout: 60
444
+ # if result.response?
445
+ # p result.response
446
+ # else
447
+ # puts "Error!"
448
+ # end
449
+ #
390
450
  def create_instance request, options = nil
391
451
  raise ::ArgumentError, "request must be provided" if request.nil?
392
452
 
@@ -404,16 +464,20 @@ module Google
404
464
  gapic_version: ::Google::Cloud::Memcache::V1::VERSION
405
465
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
406
466
 
407
- header_params = {
408
- "parent" => request.parent
409
- }
467
+ header_params = {}
468
+ if request.parent
469
+ header_params["parent"] = request.parent
470
+ end
471
+
410
472
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
411
473
  metadata[:"x-goog-request-params"] ||= request_params_header
412
474
 
413
475
  options.apply_defaults timeout: @config.rpcs.create_instance.timeout,
414
476
  metadata: metadata,
415
477
  retry_policy: @config.rpcs.create_instance.retry_policy
416
- options.apply_defaults metadata: @config.metadata,
478
+
479
+ options.apply_defaults timeout: @config.timeout,
480
+ metadata: @config.metadata,
417
481
  retry_policy: @config.retry_policy
418
482
 
419
483
  @cloud_memcache_stub.call_rpc :create_instance, request, options: options do |response, operation|
@@ -458,6 +522,28 @@ module Google
458
522
  #
459
523
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
460
524
  #
525
+ # @example Basic example
526
+ # require "google/cloud/memcache/v1"
527
+ #
528
+ # # Create a client object. The client can be reused for multiple calls.
529
+ # client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
530
+ #
531
+ # # Create a request. To set request fields, pass in keyword arguments.
532
+ # request = Google::Cloud::Memcache::V1::UpdateInstanceRequest.new
533
+ #
534
+ # # Call the update_instance method.
535
+ # result = client.update_instance request
536
+ #
537
+ # # The returned object is of type Gapic::Operation. You can use this
538
+ # # object to check the status of an operation, cancel it, or wait
539
+ # # for results. Here is how to block until completion:
540
+ # result.wait_until_done! timeout: 60
541
+ # if result.response?
542
+ # p result.response
543
+ # else
544
+ # puts "Error!"
545
+ # end
546
+ #
461
547
  def update_instance request, options = nil
462
548
  raise ::ArgumentError, "request must be provided" if request.nil?
463
549
 
@@ -475,16 +561,20 @@ module Google
475
561
  gapic_version: ::Google::Cloud::Memcache::V1::VERSION
476
562
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
477
563
 
478
- header_params = {
479
- "instance.name" => request.instance.name
480
- }
564
+ header_params = {}
565
+ if request.instance&.name
566
+ header_params["instance.name"] = request.instance.name
567
+ end
568
+
481
569
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
482
570
  metadata[:"x-goog-request-params"] ||= request_params_header
483
571
 
484
572
  options.apply_defaults timeout: @config.rpcs.update_instance.timeout,
485
573
  metadata: metadata,
486
574
  retry_policy: @config.rpcs.update_instance.retry_policy
487
- options.apply_defaults metadata: @config.metadata,
575
+
576
+ options.apply_defaults timeout: @config.timeout,
577
+ metadata: @config.metadata,
488
578
  retry_policy: @config.retry_policy
489
579
 
490
580
  @cloud_memcache_stub.call_rpc :update_instance, request, options: options do |response, operation|
@@ -532,6 +622,28 @@ module Google
532
622
  #
533
623
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
534
624
  #
625
+ # @example Basic example
626
+ # require "google/cloud/memcache/v1"
627
+ #
628
+ # # Create a client object. The client can be reused for multiple calls.
629
+ # client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
630
+ #
631
+ # # Create a request. To set request fields, pass in keyword arguments.
632
+ # request = Google::Cloud::Memcache::V1::UpdateParametersRequest.new
633
+ #
634
+ # # Call the update_parameters method.
635
+ # result = client.update_parameters request
636
+ #
637
+ # # The returned object is of type Gapic::Operation. You can use this
638
+ # # object to check the status of an operation, cancel it, or wait
639
+ # # for results. Here is how to block until completion:
640
+ # result.wait_until_done! timeout: 60
641
+ # if result.response?
642
+ # p result.response
643
+ # else
644
+ # puts "Error!"
645
+ # end
646
+ #
535
647
  def update_parameters request, options = nil
536
648
  raise ::ArgumentError, "request must be provided" if request.nil?
537
649
 
@@ -549,16 +661,20 @@ module Google
549
661
  gapic_version: ::Google::Cloud::Memcache::V1::VERSION
550
662
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
551
663
 
552
- header_params = {
553
- "name" => request.name
554
- }
664
+ header_params = {}
665
+ if request.name
666
+ header_params["name"] = request.name
667
+ end
668
+
555
669
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
556
670
  metadata[:"x-goog-request-params"] ||= request_params_header
557
671
 
558
672
  options.apply_defaults timeout: @config.rpcs.update_parameters.timeout,
559
673
  metadata: metadata,
560
674
  retry_policy: @config.rpcs.update_parameters.retry_policy
561
- options.apply_defaults metadata: @config.metadata,
675
+
676
+ options.apply_defaults timeout: @config.timeout,
677
+ metadata: @config.metadata,
562
678
  retry_policy: @config.retry_policy
563
679
 
564
680
  @cloud_memcache_stub.call_rpc :update_parameters, request, options: options do |response, operation|
@@ -601,6 +717,28 @@ module Google
601
717
  #
602
718
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
603
719
  #
720
+ # @example Basic example
721
+ # require "google/cloud/memcache/v1"
722
+ #
723
+ # # Create a client object. The client can be reused for multiple calls.
724
+ # client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
725
+ #
726
+ # # Create a request. To set request fields, pass in keyword arguments.
727
+ # request = Google::Cloud::Memcache::V1::DeleteInstanceRequest.new
728
+ #
729
+ # # Call the delete_instance method.
730
+ # result = client.delete_instance request
731
+ #
732
+ # # The returned object is of type Gapic::Operation. You can use this
733
+ # # object to check the status of an operation, cancel it, or wait
734
+ # # for results. Here is how to block until completion:
735
+ # result.wait_until_done! timeout: 60
736
+ # if result.response?
737
+ # p result.response
738
+ # else
739
+ # puts "Error!"
740
+ # end
741
+ #
604
742
  def delete_instance request, options = nil
605
743
  raise ::ArgumentError, "request must be provided" if request.nil?
606
744
 
@@ -618,16 +756,20 @@ module Google
618
756
  gapic_version: ::Google::Cloud::Memcache::V1::VERSION
619
757
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
620
758
 
621
- header_params = {
622
- "name" => request.name
623
- }
759
+ header_params = {}
760
+ if request.name
761
+ header_params["name"] = request.name
762
+ end
763
+
624
764
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
625
765
  metadata[:"x-goog-request-params"] ||= request_params_header
626
766
 
627
767
  options.apply_defaults timeout: @config.rpcs.delete_instance.timeout,
628
768
  metadata: metadata,
629
769
  retry_policy: @config.rpcs.delete_instance.retry_policy
630
- options.apply_defaults metadata: @config.metadata,
770
+
771
+ options.apply_defaults timeout: @config.timeout,
772
+ metadata: @config.metadata,
631
773
  retry_policy: @config.retry_policy
632
774
 
633
775
  @cloud_memcache_stub.call_rpc :delete_instance, request, options: options do |response, operation|
@@ -676,6 +818,28 @@ module Google
676
818
  #
677
819
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
678
820
  #
821
+ # @example Basic example
822
+ # require "google/cloud/memcache/v1"
823
+ #
824
+ # # Create a client object. The client can be reused for multiple calls.
825
+ # client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
826
+ #
827
+ # # Create a request. To set request fields, pass in keyword arguments.
828
+ # request = Google::Cloud::Memcache::V1::ApplyParametersRequest.new
829
+ #
830
+ # # Call the apply_parameters method.
831
+ # result = client.apply_parameters request
832
+ #
833
+ # # The returned object is of type Gapic::Operation. You can use this
834
+ # # object to check the status of an operation, cancel it, or wait
835
+ # # for results. Here is how to block until completion:
836
+ # result.wait_until_done! timeout: 60
837
+ # if result.response?
838
+ # p result.response
839
+ # else
840
+ # puts "Error!"
841
+ # end
842
+ #
679
843
  def apply_parameters request, options = nil
680
844
  raise ::ArgumentError, "request must be provided" if request.nil?
681
845
 
@@ -693,16 +857,20 @@ module Google
693
857
  gapic_version: ::Google::Cloud::Memcache::V1::VERSION
694
858
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
695
859
 
696
- header_params = {
697
- "name" => request.name
698
- }
860
+ header_params = {}
861
+ if request.name
862
+ header_params["name"] = request.name
863
+ end
864
+
699
865
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
700
866
  metadata[:"x-goog-request-params"] ||= request_params_header
701
867
 
702
868
  options.apply_defaults timeout: @config.rpcs.apply_parameters.timeout,
703
869
  metadata: metadata,
704
870
  retry_policy: @config.rpcs.apply_parameters.retry_policy
705
- options.apply_defaults metadata: @config.metadata,
871
+
872
+ options.apply_defaults timeout: @config.timeout,
873
+ metadata: @config.metadata,
706
874
  retry_policy: @config.retry_policy
707
875
 
708
876
  @cloud_memcache_stub.call_rpc :apply_parameters, request, options: options do |response, operation|
@@ -727,22 +895,21 @@ module Google
727
895
  # Configuration can be applied globally to all clients, or to a single client
728
896
  # on construction.
729
897
  #
730
- # # Examples
731
- #
732
- # To modify the global config, setting the timeout for list_instances
733
- # to 20 seconds, and all remaining timeouts to 10 seconds:
734
- #
735
- # ::Google::Cloud::Memcache::V1::CloudMemcache::Client.configure do |config|
736
- # config.timeout = 10.0
737
- # config.rpcs.list_instances.timeout = 20.0
738
- # end
739
- #
740
- # To apply the above configuration only to a new client:
741
- #
742
- # client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new do |config|
743
- # config.timeout = 10.0
744
- # config.rpcs.list_instances.timeout = 20.0
745
- # end
898
+ # @example
899
+ #
900
+ # # Modify the global config, setting the timeout for
901
+ # # list_instances to 20 seconds,
902
+ # # and all remaining timeouts to 10 seconds.
903
+ # ::Google::Cloud::Memcache::V1::CloudMemcache::Client.configure do |config|
904
+ # config.timeout = 10.0
905
+ # config.rpcs.list_instances.timeout = 20.0
906
+ # end
907
+ #
908
+ # # Apply the above configuration only to a new client.
909
+ # client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new do |config|
910
+ # config.timeout = 10.0
911
+ # config.rpcs.list_instances.timeout = 20.0
912
+ # end
746
913
  #
747
914
  # @!attribute [rw] endpoint
748
915
  # 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::Memcache::V1::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::Memcache::V1::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::Memcache::V1::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::Memcache::V1::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/memcache/v1/cloud_memcache.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/memcache/v1/cloud_memcache.proto", :syntax => :proto3) do
15
15
  add_message "google.cloud.memcache.v1.Instance" do
@@ -41,7 +41,7 @@ module Google
41
41
  # * `projects/my-memcached-project/locations/us-central1/instances/my-memcached`
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 Memcache
23
23
  module V1
24
- VERSION = "0.2.0"
24
+ VERSION = "0.2.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-memcache-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 0.2.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-08 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 Memcached V1 API