google-cloud-kms-v1 0.22.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 64473976f0753f689b4cefdd08c0c94c1f754aa204f01a3b64d4f3320fb38f37
4
- data.tar.gz: 78b7ddfb19d188f94838b3e654ad250a3567003b34a5024b28e1bf6b068b852a
3
+ metadata.gz: 1dec37e0132e3a5152edb7d89eb91ab3686393708c990ccf7ddf00dc817820cb
4
+ data.tar.gz: 245ac49330e68941946c310659cc7368b7240d011c0e291a162e3d748341b04b
5
5
  SHA512:
6
- metadata.gz: afc8c97105c0bf92812f41a71da15550f9602de8eaf8b82a79b41ec426682c8d5127a4b9ff20cca255e5f9a7b45bda77f1ac1b3dfc4934a3808ed1ab4f5db17a
7
- data.tar.gz: 021f3ecca9cf17537cd6f93b62c606fbed0860a2498d30d03fe6cddb75a8ac70de3822fe70eb96416d4217ad98f06a236b76b50c6d92c3c31dcd81a0a7eb78f8
6
+ metadata.gz: 11a2b354ac86ded1667472327168a2966114ecf8cf304581ab2b6d7930f11580200da850abb5429ab380421999a3b2c71ef9560f43fd14b4cd874177c18dc608
7
+ data.tar.gz: e9ecc33b0aac7e1789a23636e3ba51e7e76ee7298e8b5ffb69bdf3c822a91915e199e733bfef2ddcb50e7539ede11f8424008ba44862c5963ac8d5e0b41df8d0
@@ -176,7 +176,8 @@ module Google
176
176
  credentials: credentials,
177
177
  endpoint: @config.endpoint,
178
178
  channel_args: @config.channel_args,
179
- interceptors: @config.interceptors
179
+ interceptors: @config.interceptors,
180
+ channel_pool_config: @config.channel_pool
180
181
  )
181
182
  end
182
183
 
@@ -962,6 +963,14 @@ module Google
962
963
  end
963
964
  end
964
965
 
966
+ ##
967
+ # Configuration for the channel pool
968
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
969
+ #
970
+ def channel_pool
971
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
972
+ end
973
+
965
974
  ##
966
975
  # Configuration RPC class for the EkmService API.
967
976
  #
@@ -239,6 +239,26 @@ module Google
239
239
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::EkmConnection>]
240
240
  #
241
241
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
242
+ #
243
+ # @example Basic example
244
+ # require "google/cloud/kms/v1"
245
+ #
246
+ # # Create a client object. The client can be reused for multiple calls.
247
+ # client = Google::Cloud::Kms::V1::EkmService::Rest::Client.new
248
+ #
249
+ # # Create a request. To set request fields, pass in keyword arguments.
250
+ # request = Google::Cloud::Kms::V1::ListEkmConnectionsRequest.new
251
+ #
252
+ # # Call the list_ekm_connections method.
253
+ # result = client.list_ekm_connections request
254
+ #
255
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
256
+ # # over elements, and API calls will be issued to fetch pages as needed.
257
+ # result.each do |item|
258
+ # # Each element is of type ::Google::Cloud::Kms::V1::EkmConnection.
259
+ # p item
260
+ # end
261
+ #
242
262
  def list_ekm_connections request, options = nil
243
263
  raise ::ArgumentError, "request must be provided" if request.nil?
244
264
 
@@ -304,6 +324,22 @@ module Google
304
324
  # @return [::Google::Cloud::Kms::V1::EkmConnection]
305
325
  #
306
326
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
327
+ #
328
+ # @example Basic example
329
+ # require "google/cloud/kms/v1"
330
+ #
331
+ # # Create a client object. The client can be reused for multiple calls.
332
+ # client = Google::Cloud::Kms::V1::EkmService::Rest::Client.new
333
+ #
334
+ # # Create a request. To set request fields, pass in keyword arguments.
335
+ # request = Google::Cloud::Kms::V1::GetEkmConnectionRequest.new
336
+ #
337
+ # # Call the get_ekm_connection method.
338
+ # result = client.get_ekm_connection request
339
+ #
340
+ # # The returned object is of type Google::Cloud::Kms::V1::EkmConnection.
341
+ # p result
342
+ #
307
343
  def get_ekm_connection request, options = nil
308
344
  raise ::ArgumentError, "request must be provided" if request.nil?
309
345
 
@@ -375,6 +411,22 @@ module Google
375
411
  # @return [::Google::Cloud::Kms::V1::EkmConnection]
376
412
  #
377
413
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
414
+ #
415
+ # @example Basic example
416
+ # require "google/cloud/kms/v1"
417
+ #
418
+ # # Create a client object. The client can be reused for multiple calls.
419
+ # client = Google::Cloud::Kms::V1::EkmService::Rest::Client.new
420
+ #
421
+ # # Create a request. To set request fields, pass in keyword arguments.
422
+ # request = Google::Cloud::Kms::V1::CreateEkmConnectionRequest.new
423
+ #
424
+ # # Call the create_ekm_connection method.
425
+ # result = client.create_ekm_connection request
426
+ #
427
+ # # The returned object is of type Google::Cloud::Kms::V1::EkmConnection.
428
+ # p result
429
+ #
378
430
  def create_ekm_connection request, options = nil
379
431
  raise ::ArgumentError, "request must be provided" if request.nil?
380
432
 
@@ -440,6 +492,22 @@ module Google
440
492
  # @return [::Google::Cloud::Kms::V1::EkmConnection]
441
493
  #
442
494
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
495
+ #
496
+ # @example Basic example
497
+ # require "google/cloud/kms/v1"
498
+ #
499
+ # # Create a client object. The client can be reused for multiple calls.
500
+ # client = Google::Cloud::Kms::V1::EkmService::Rest::Client.new
501
+ #
502
+ # # Create a request. To set request fields, pass in keyword arguments.
503
+ # request = Google::Cloud::Kms::V1::UpdateEkmConnectionRequest.new
504
+ #
505
+ # # Call the update_ekm_connection method.
506
+ # result = client.update_ekm_connection request
507
+ #
508
+ # # The returned object is of type Google::Cloud::Kms::V1::EkmConnection.
509
+ # p result
510
+ #
443
511
  def update_ekm_connection request, options = nil
444
512
  raise ::ArgumentError, "request must be provided" if request.nil?
445
513
 
@@ -504,6 +572,22 @@ module Google
504
572
  # @return [::Google::Cloud::Kms::V1::EkmConfig]
505
573
  #
506
574
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
575
+ #
576
+ # @example Basic example
577
+ # require "google/cloud/kms/v1"
578
+ #
579
+ # # Create a client object. The client can be reused for multiple calls.
580
+ # client = Google::Cloud::Kms::V1::EkmService::Rest::Client.new
581
+ #
582
+ # # Create a request. To set request fields, pass in keyword arguments.
583
+ # request = Google::Cloud::Kms::V1::GetEkmConfigRequest.new
584
+ #
585
+ # # Call the get_ekm_config method.
586
+ # result = client.get_ekm_config request
587
+ #
588
+ # # The returned object is of type Google::Cloud::Kms::V1::EkmConfig.
589
+ # p result
590
+ #
507
591
  def get_ekm_config request, options = nil
508
592
  raise ::ArgumentError, "request must be provided" if request.nil?
509
593
 
@@ -569,6 +653,22 @@ module Google
569
653
  # @return [::Google::Cloud::Kms::V1::EkmConfig]
570
654
  #
571
655
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
656
+ #
657
+ # @example Basic example
658
+ # require "google/cloud/kms/v1"
659
+ #
660
+ # # Create a client object. The client can be reused for multiple calls.
661
+ # client = Google::Cloud::Kms::V1::EkmService::Rest::Client.new
662
+ #
663
+ # # Create a request. To set request fields, pass in keyword arguments.
664
+ # request = Google::Cloud::Kms::V1::UpdateEkmConfigRequest.new
665
+ #
666
+ # # Call the update_ekm_config method.
667
+ # result = client.update_ekm_config request
668
+ #
669
+ # # The returned object is of type Google::Cloud::Kms::V1::EkmConfig.
670
+ # p result
671
+ #
572
672
  def update_ekm_config request, options = nil
573
673
  raise ::ArgumentError, "request must be provided" if request.nil?
574
674
 
@@ -636,6 +736,22 @@ module Google
636
736
  # @return [::Google::Cloud::Kms::V1::VerifyConnectivityResponse]
637
737
  #
638
738
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
739
+ #
740
+ # @example Basic example
741
+ # require "google/cloud/kms/v1"
742
+ #
743
+ # # Create a client object. The client can be reused for multiple calls.
744
+ # client = Google::Cloud::Kms::V1::EkmService::Rest::Client.new
745
+ #
746
+ # # Create a request. To set request fields, pass in keyword arguments.
747
+ # request = Google::Cloud::Kms::V1::VerifyConnectivityRequest.new
748
+ #
749
+ # # Call the verify_connectivity method.
750
+ # result = client.verify_connectivity request
751
+ #
752
+ # # The returned object is of type Google::Cloud::Kms::V1::VerifyConnectivityResponse.
753
+ # p result
754
+ #
639
755
  def verify_connectivity request, options = nil
640
756
  raise ::ArgumentError, "request must be provided" if request.nil?
641
757
 
@@ -287,7 +287,8 @@ module Google
287
287
  credentials: credentials,
288
288
  endpoint: @config.endpoint,
289
289
  channel_args: @config.channel_args,
290
- interceptors: @config.interceptors
290
+ interceptors: @config.interceptors,
291
+ channel_pool_config: @config.channel_pool
291
292
  )
292
293
  end
293
294
 
@@ -3580,6 +3581,14 @@ module Google
3580
3581
  end
3581
3582
  end
3582
3583
 
3584
+ ##
3585
+ # Configuration for the channel pool
3586
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
3587
+ #
3588
+ def channel_pool
3589
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
3590
+ end
3591
+
3583
3592
  ##
3584
3593
  # Configuration RPC class for the KeyManagementService API.
3585
3594
  #
@@ -350,6 +350,26 @@ module Google
350
350
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::KeyRing>]
351
351
  #
352
352
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
353
+ #
354
+ # @example Basic example
355
+ # require "google/cloud/kms/v1"
356
+ #
357
+ # # Create a client object. The client can be reused for multiple calls.
358
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
359
+ #
360
+ # # Create a request. To set request fields, pass in keyword arguments.
361
+ # request = Google::Cloud::Kms::V1::ListKeyRingsRequest.new
362
+ #
363
+ # # Call the list_key_rings method.
364
+ # result = client.list_key_rings request
365
+ #
366
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
367
+ # # over elements, and API calls will be issued to fetch pages as needed.
368
+ # result.each do |item|
369
+ # # Each element is of type ::Google::Cloud::Kms::V1::KeyRing.
370
+ # p item
371
+ # end
372
+ #
353
373
  def list_key_rings request, options = nil
354
374
  raise ::ArgumentError, "request must be provided" if request.nil?
355
375
 
@@ -437,6 +457,26 @@ module Google
437
457
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::CryptoKey>]
438
458
  #
439
459
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
460
+ #
461
+ # @example Basic example
462
+ # require "google/cloud/kms/v1"
463
+ #
464
+ # # Create a client object. The client can be reused for multiple calls.
465
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
466
+ #
467
+ # # Create a request. To set request fields, pass in keyword arguments.
468
+ # request = Google::Cloud::Kms::V1::ListCryptoKeysRequest.new
469
+ #
470
+ # # Call the list_crypto_keys method.
471
+ # result = client.list_crypto_keys request
472
+ #
473
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
474
+ # # over elements, and API calls will be issued to fetch pages as needed.
475
+ # result.each do |item|
476
+ # # Each element is of type ::Google::Cloud::Kms::V1::CryptoKey.
477
+ # p item
478
+ # end
479
+ #
440
480
  def list_crypto_keys request, options = nil
441
481
  raise ::ArgumentError, "request must be provided" if request.nil?
442
482
 
@@ -525,6 +565,26 @@ module Google
525
565
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::CryptoKeyVersion>]
526
566
  #
527
567
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
568
+ #
569
+ # @example Basic example
570
+ # require "google/cloud/kms/v1"
571
+ #
572
+ # # Create a client object. The client can be reused for multiple calls.
573
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
574
+ #
575
+ # # Create a request. To set request fields, pass in keyword arguments.
576
+ # request = Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest.new
577
+ #
578
+ # # Call the list_crypto_key_versions method.
579
+ # result = client.list_crypto_key_versions request
580
+ #
581
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
582
+ # # over elements, and API calls will be issued to fetch pages as needed.
583
+ # result.each do |item|
584
+ # # Each element is of type ::Google::Cloud::Kms::V1::CryptoKeyVersion.
585
+ # p item
586
+ # end
587
+ #
528
588
  def list_crypto_key_versions request, options = nil
529
589
  raise ::ArgumentError, "request must be provided" if request.nil?
530
590
 
@@ -610,6 +670,26 @@ module Google
610
670
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Kms::V1::ImportJob>]
611
671
  #
612
672
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
673
+ #
674
+ # @example Basic example
675
+ # require "google/cloud/kms/v1"
676
+ #
677
+ # # Create a client object. The client can be reused for multiple calls.
678
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
679
+ #
680
+ # # Create a request. To set request fields, pass in keyword arguments.
681
+ # request = Google::Cloud::Kms::V1::ListImportJobsRequest.new
682
+ #
683
+ # # Call the list_import_jobs method.
684
+ # result = client.list_import_jobs request
685
+ #
686
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
687
+ # # over elements, and API calls will be issued to fetch pages as needed.
688
+ # result.each do |item|
689
+ # # Each element is of type ::Google::Cloud::Kms::V1::ImportJob.
690
+ # p item
691
+ # end
692
+ #
613
693
  def list_import_jobs request, options = nil
614
694
  raise ::ArgumentError, "request must be provided" if request.nil?
615
695
 
@@ -674,6 +754,22 @@ module Google
674
754
  # @return [::Google::Cloud::Kms::V1::KeyRing]
675
755
  #
676
756
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
757
+ #
758
+ # @example Basic example
759
+ # require "google/cloud/kms/v1"
760
+ #
761
+ # # Create a client object. The client can be reused for multiple calls.
762
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
763
+ #
764
+ # # Create a request. To set request fields, pass in keyword arguments.
765
+ # request = Google::Cloud::Kms::V1::GetKeyRingRequest.new
766
+ #
767
+ # # Call the get_key_ring method.
768
+ # result = client.get_key_ring request
769
+ #
770
+ # # The returned object is of type Google::Cloud::Kms::V1::KeyRing.
771
+ # p result
772
+ #
677
773
  def get_key_ring request, options = nil
678
774
  raise ::ArgumentError, "request must be provided" if request.nil?
679
775
 
@@ -739,6 +835,22 @@ module Google
739
835
  # @return [::Google::Cloud::Kms::V1::CryptoKey]
740
836
  #
741
837
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
838
+ #
839
+ # @example Basic example
840
+ # require "google/cloud/kms/v1"
841
+ #
842
+ # # Create a client object. The client can be reused for multiple calls.
843
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
844
+ #
845
+ # # Create a request. To set request fields, pass in keyword arguments.
846
+ # request = Google::Cloud::Kms::V1::GetCryptoKeyRequest.new
847
+ #
848
+ # # Call the get_crypto_key method.
849
+ # result = client.get_crypto_key request
850
+ #
851
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKey.
852
+ # p result
853
+ #
742
854
  def get_crypto_key request, options = nil
743
855
  raise ::ArgumentError, "request must be provided" if request.nil?
744
856
 
@@ -803,6 +915,22 @@ module Google
803
915
  # @return [::Google::Cloud::Kms::V1::CryptoKeyVersion]
804
916
  #
805
917
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
918
+ #
919
+ # @example Basic example
920
+ # require "google/cloud/kms/v1"
921
+ #
922
+ # # Create a client object. The client can be reused for multiple calls.
923
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
924
+ #
925
+ # # Create a request. To set request fields, pass in keyword arguments.
926
+ # request = Google::Cloud::Kms::V1::GetCryptoKeyVersionRequest.new
927
+ #
928
+ # # Call the get_crypto_key_version method.
929
+ # result = client.get_crypto_key_version request
930
+ #
931
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKeyVersion.
932
+ # p result
933
+ #
806
934
  def get_crypto_key_version request, options = nil
807
935
  raise ::ArgumentError, "request must be provided" if request.nil?
808
936
 
@@ -871,6 +999,22 @@ module Google
871
999
  # @return [::Google::Cloud::Kms::V1::PublicKey]
872
1000
  #
873
1001
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1002
+ #
1003
+ # @example Basic example
1004
+ # require "google/cloud/kms/v1"
1005
+ #
1006
+ # # Create a client object. The client can be reused for multiple calls.
1007
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1008
+ #
1009
+ # # Create a request. To set request fields, pass in keyword arguments.
1010
+ # request = Google::Cloud::Kms::V1::GetPublicKeyRequest.new
1011
+ #
1012
+ # # Call the get_public_key method.
1013
+ # result = client.get_public_key request
1014
+ #
1015
+ # # The returned object is of type Google::Cloud::Kms::V1::PublicKey.
1016
+ # p result
1017
+ #
874
1018
  def get_public_key request, options = nil
875
1019
  raise ::ArgumentError, "request must be provided" if request.nil?
876
1020
 
@@ -934,6 +1078,22 @@ module Google
934
1078
  # @return [::Google::Cloud::Kms::V1::ImportJob]
935
1079
  #
936
1080
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1081
+ #
1082
+ # @example Basic example
1083
+ # require "google/cloud/kms/v1"
1084
+ #
1085
+ # # Create a client object. The client can be reused for multiple calls.
1086
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1087
+ #
1088
+ # # Create a request. To set request fields, pass in keyword arguments.
1089
+ # request = Google::Cloud::Kms::V1::GetImportJobRequest.new
1090
+ #
1091
+ # # Call the get_import_job method.
1092
+ # result = client.get_import_job request
1093
+ #
1094
+ # # The returned object is of type Google::Cloud::Kms::V1::ImportJob.
1095
+ # p result
1096
+ #
937
1097
  def get_import_job request, options = nil
938
1098
  raise ::ArgumentError, "request must be provided" if request.nil?
939
1099
 
@@ -1005,6 +1165,22 @@ module Google
1005
1165
  # @return [::Google::Cloud::Kms::V1::KeyRing]
1006
1166
  #
1007
1167
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1168
+ #
1169
+ # @example Basic example
1170
+ # require "google/cloud/kms/v1"
1171
+ #
1172
+ # # Create a client object. The client can be reused for multiple calls.
1173
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1174
+ #
1175
+ # # Create a request. To set request fields, pass in keyword arguments.
1176
+ # request = Google::Cloud::Kms::V1::CreateKeyRingRequest.new
1177
+ #
1178
+ # # Call the create_key_ring method.
1179
+ # result = client.create_key_ring request
1180
+ #
1181
+ # # The returned object is of type Google::Cloud::Kms::V1::KeyRing.
1182
+ # p result
1183
+ #
1008
1184
  def create_key_ring request, options = nil
1009
1185
  raise ::ArgumentError, "request must be provided" if request.nil?
1010
1186
 
@@ -1088,6 +1264,22 @@ module Google
1088
1264
  # @return [::Google::Cloud::Kms::V1::CryptoKey]
1089
1265
  #
1090
1266
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1267
+ #
1268
+ # @example Basic example
1269
+ # require "google/cloud/kms/v1"
1270
+ #
1271
+ # # Create a client object. The client can be reused for multiple calls.
1272
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1273
+ #
1274
+ # # Create a request. To set request fields, pass in keyword arguments.
1275
+ # request = Google::Cloud::Kms::V1::CreateCryptoKeyRequest.new
1276
+ #
1277
+ # # Call the create_crypto_key method.
1278
+ # result = client.create_crypto_key request
1279
+ #
1280
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKey.
1281
+ # p result
1282
+ #
1091
1283
  def create_crypto_key request, options = nil
1092
1284
  raise ::ArgumentError, "request must be provided" if request.nil?
1093
1285
 
@@ -1160,6 +1352,22 @@ module Google
1160
1352
  # @return [::Google::Cloud::Kms::V1::CryptoKeyVersion]
1161
1353
  #
1162
1354
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1355
+ #
1356
+ # @example Basic example
1357
+ # require "google/cloud/kms/v1"
1358
+ #
1359
+ # # Create a client object. The client can be reused for multiple calls.
1360
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1361
+ #
1362
+ # # Create a request. To set request fields, pass in keyword arguments.
1363
+ # request = Google::Cloud::Kms::V1::CreateCryptoKeyVersionRequest.new
1364
+ #
1365
+ # # Call the create_crypto_key_version method.
1366
+ # result = client.create_crypto_key_version request
1367
+ #
1368
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKeyVersion.
1369
+ # p result
1370
+ #
1163
1371
  def create_crypto_key_version request, options = nil
1164
1372
  raise ::ArgumentError, "request must be provided" if request.nil?
1165
1373
 
@@ -1309,6 +1517,22 @@ module Google
1309
1517
  # @return [::Google::Cloud::Kms::V1::CryptoKeyVersion]
1310
1518
  #
1311
1519
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1520
+ #
1521
+ # @example Basic example
1522
+ # require "google/cloud/kms/v1"
1523
+ #
1524
+ # # Create a client object. The client can be reused for multiple calls.
1525
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1526
+ #
1527
+ # # Create a request. To set request fields, pass in keyword arguments.
1528
+ # request = Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest.new
1529
+ #
1530
+ # # Call the import_crypto_key_version method.
1531
+ # result = client.import_crypto_key_version request
1532
+ #
1533
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKeyVersion.
1534
+ # p result
1535
+ #
1312
1536
  def import_crypto_key_version request, options = nil
1313
1537
  raise ::ArgumentError, "request must be provided" if request.nil?
1314
1538
 
@@ -1383,6 +1607,22 @@ module Google
1383
1607
  # @return [::Google::Cloud::Kms::V1::ImportJob]
1384
1608
  #
1385
1609
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1610
+ #
1611
+ # @example Basic example
1612
+ # require "google/cloud/kms/v1"
1613
+ #
1614
+ # # Create a client object. The client can be reused for multiple calls.
1615
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1616
+ #
1617
+ # # Create a request. To set request fields, pass in keyword arguments.
1618
+ # request = Google::Cloud::Kms::V1::CreateImportJobRequest.new
1619
+ #
1620
+ # # Call the create_import_job method.
1621
+ # result = client.create_import_job request
1622
+ #
1623
+ # # The returned object is of type Google::Cloud::Kms::V1::ImportJob.
1624
+ # p result
1625
+ #
1386
1626
  def create_import_job request, options = nil
1387
1627
  raise ::ArgumentError, "request must be provided" if request.nil?
1388
1628
 
@@ -1447,6 +1687,22 @@ module Google
1447
1687
  # @return [::Google::Cloud::Kms::V1::CryptoKey]
1448
1688
  #
1449
1689
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1690
+ #
1691
+ # @example Basic example
1692
+ # require "google/cloud/kms/v1"
1693
+ #
1694
+ # # Create a client object. The client can be reused for multiple calls.
1695
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1696
+ #
1697
+ # # Create a request. To set request fields, pass in keyword arguments.
1698
+ # request = Google::Cloud::Kms::V1::UpdateCryptoKeyRequest.new
1699
+ #
1700
+ # # Call the update_crypto_key method.
1701
+ # result = client.update_crypto_key request
1702
+ #
1703
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKey.
1704
+ # p result
1705
+ #
1450
1706
  def update_crypto_key request, options = nil
1451
1707
  raise ::ArgumentError, "request must be provided" if request.nil?
1452
1708
 
@@ -1523,6 +1779,22 @@ module Google
1523
1779
  # @return [::Google::Cloud::Kms::V1::CryptoKeyVersion]
1524
1780
  #
1525
1781
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1782
+ #
1783
+ # @example Basic example
1784
+ # require "google/cloud/kms/v1"
1785
+ #
1786
+ # # Create a client object. The client can be reused for multiple calls.
1787
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1788
+ #
1789
+ # # Create a request. To set request fields, pass in keyword arguments.
1790
+ # request = Google::Cloud::Kms::V1::UpdateCryptoKeyVersionRequest.new
1791
+ #
1792
+ # # Call the update_crypto_key_version method.
1793
+ # result = client.update_crypto_key_version request
1794
+ #
1795
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKeyVersion.
1796
+ # p result
1797
+ #
1526
1798
  def update_crypto_key_version request, options = nil
1527
1799
  raise ::ArgumentError, "request must be provided" if request.nil?
1528
1800
 
@@ -1594,6 +1866,22 @@ module Google
1594
1866
  # @return [::Google::Cloud::Kms::V1::CryptoKey]
1595
1867
  #
1596
1868
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1869
+ #
1870
+ # @example Basic example
1871
+ # require "google/cloud/kms/v1"
1872
+ #
1873
+ # # Create a client object. The client can be reused for multiple calls.
1874
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1875
+ #
1876
+ # # Create a request. To set request fields, pass in keyword arguments.
1877
+ # request = Google::Cloud::Kms::V1::UpdateCryptoKeyPrimaryVersionRequest.new
1878
+ #
1879
+ # # Call the update_crypto_key_primary_version method.
1880
+ # result = client.update_crypto_key_primary_version request
1881
+ #
1882
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKey.
1883
+ # p result
1884
+ #
1597
1885
  def update_crypto_key_primary_version request, options = nil
1598
1886
  raise ::ArgumentError, "request must be provided" if request.nil?
1599
1887
 
@@ -1677,6 +1965,22 @@ module Google
1677
1965
  # @return [::Google::Cloud::Kms::V1::CryptoKeyVersion]
1678
1966
  #
1679
1967
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1968
+ #
1969
+ # @example Basic example
1970
+ # require "google/cloud/kms/v1"
1971
+ #
1972
+ # # Create a client object. The client can be reused for multiple calls.
1973
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
1974
+ #
1975
+ # # Create a request. To set request fields, pass in keyword arguments.
1976
+ # request = Google::Cloud::Kms::V1::DestroyCryptoKeyVersionRequest.new
1977
+ #
1978
+ # # Call the destroy_crypto_key_version method.
1979
+ # result = client.destroy_crypto_key_version request
1980
+ #
1981
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKeyVersion.
1982
+ # p result
1983
+ #
1680
1984
  def destroy_crypto_key_version request, options = nil
1681
1985
  raise ::ArgumentError, "request must be provided" if request.nil?
1682
1986
 
@@ -1748,6 +2052,22 @@ module Google
1748
2052
  # @return [::Google::Cloud::Kms::V1::CryptoKeyVersion]
1749
2053
  #
1750
2054
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2055
+ #
2056
+ # @example Basic example
2057
+ # require "google/cloud/kms/v1"
2058
+ #
2059
+ # # Create a client object. The client can be reused for multiple calls.
2060
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
2061
+ #
2062
+ # # Create a request. To set request fields, pass in keyword arguments.
2063
+ # request = Google::Cloud::Kms::V1::RestoreCryptoKeyVersionRequest.new
2064
+ #
2065
+ # # Call the restore_crypto_key_version method.
2066
+ # result = client.restore_crypto_key_version request
2067
+ #
2068
+ # # The returned object is of type Google::Cloud::Kms::V1::CryptoKeyVersion.
2069
+ # p result
2070
+ #
1751
2071
  def restore_crypto_key_version request, options = nil
1752
2072
  raise ::ArgumentError, "request must be provided" if request.nil?
1753
2073
 
@@ -1885,6 +2205,22 @@ module Google
1885
2205
  # @return [::Google::Cloud::Kms::V1::EncryptResponse]
1886
2206
  #
1887
2207
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2208
+ #
2209
+ # @example Basic example
2210
+ # require "google/cloud/kms/v1"
2211
+ #
2212
+ # # Create a client object. The client can be reused for multiple calls.
2213
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
2214
+ #
2215
+ # # Create a request. To set request fields, pass in keyword arguments.
2216
+ # request = Google::Cloud::Kms::V1::EncryptRequest.new
2217
+ #
2218
+ # # Call the encrypt method.
2219
+ # result = client.encrypt request
2220
+ #
2221
+ # # The returned object is of type Google::Cloud::Kms::V1::EncryptResponse.
2222
+ # p result
2223
+ #
1888
2224
  def encrypt request, options = nil
1889
2225
  raise ::ArgumentError, "request must be provided" if request.nil?
1890
2226
 
@@ -1998,6 +2334,22 @@ module Google
1998
2334
  # @return [::Google::Cloud::Kms::V1::DecryptResponse]
1999
2335
  #
2000
2336
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2337
+ #
2338
+ # @example Basic example
2339
+ # require "google/cloud/kms/v1"
2340
+ #
2341
+ # # Create a client object. The client can be reused for multiple calls.
2342
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
2343
+ #
2344
+ # # Create a request. To set request fields, pass in keyword arguments.
2345
+ # request = Google::Cloud::Kms::V1::DecryptRequest.new
2346
+ #
2347
+ # # Call the decrypt method.
2348
+ # result = client.decrypt request
2349
+ #
2350
+ # # The returned object is of type Google::Cloud::Kms::V1::DecryptResponse.
2351
+ # p result
2352
+ #
2001
2353
  def decrypt request, options = nil
2002
2354
  raise ::ArgumentError, "request must be provided" if request.nil?
2003
2355
 
@@ -2148,6 +2500,22 @@ module Google
2148
2500
  # @return [::Google::Cloud::Kms::V1::RawEncryptResponse]
2149
2501
  #
2150
2502
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2503
+ #
2504
+ # @example Basic example
2505
+ # require "google/cloud/kms/v1"
2506
+ #
2507
+ # # Create a client object. The client can be reused for multiple calls.
2508
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
2509
+ #
2510
+ # # Create a request. To set request fields, pass in keyword arguments.
2511
+ # request = Google::Cloud::Kms::V1::RawEncryptRequest.new
2512
+ #
2513
+ # # Call the raw_encrypt method.
2514
+ # result = client.raw_encrypt request
2515
+ #
2516
+ # # The returned object is of type Google::Cloud::Kms::V1::RawEncryptResponse.
2517
+ # p result
2518
+ #
2151
2519
  def raw_encrypt request, options = nil
2152
2520
  raise ::ArgumentError, "request must be provided" if request.nil?
2153
2521
 
@@ -2278,6 +2646,22 @@ module Google
2278
2646
  # @return [::Google::Cloud::Kms::V1::RawDecryptResponse]
2279
2647
  #
2280
2648
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2649
+ #
2650
+ # @example Basic example
2651
+ # require "google/cloud/kms/v1"
2652
+ #
2653
+ # # Create a client object. The client can be reused for multiple calls.
2654
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
2655
+ #
2656
+ # # Create a request. To set request fields, pass in keyword arguments.
2657
+ # request = Google::Cloud::Kms::V1::RawDecryptRequest.new
2658
+ #
2659
+ # # Call the raw_decrypt method.
2660
+ # result = client.raw_decrypt request
2661
+ #
2662
+ # # The returned object is of type Google::Cloud::Kms::V1::RawDecryptResponse.
2663
+ # p result
2664
+ #
2281
2665
  def raw_decrypt request, options = nil
2282
2666
  raise ::ArgumentError, "request must be provided" if request.nil?
2283
2667
 
@@ -2399,6 +2783,22 @@ module Google
2399
2783
  # @return [::Google::Cloud::Kms::V1::AsymmetricSignResponse]
2400
2784
  #
2401
2785
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2786
+ #
2787
+ # @example Basic example
2788
+ # require "google/cloud/kms/v1"
2789
+ #
2790
+ # # Create a client object. The client can be reused for multiple calls.
2791
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
2792
+ #
2793
+ # # Create a request. To set request fields, pass in keyword arguments.
2794
+ # request = Google::Cloud::Kms::V1::AsymmetricSignRequest.new
2795
+ #
2796
+ # # Call the asymmetric_sign method.
2797
+ # result = client.asymmetric_sign request
2798
+ #
2799
+ # # The returned object is of type Google::Cloud::Kms::V1::AsymmetricSignResponse.
2800
+ # p result
2801
+ #
2402
2802
  def asymmetric_sign request, options = nil
2403
2803
  raise ::ArgumentError, "request must be provided" if request.nil?
2404
2804
 
@@ -2491,6 +2891,22 @@ module Google
2491
2891
  # @return [::Google::Cloud::Kms::V1::AsymmetricDecryptResponse]
2492
2892
  #
2493
2893
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2894
+ #
2895
+ # @example Basic example
2896
+ # require "google/cloud/kms/v1"
2897
+ #
2898
+ # # Create a client object. The client can be reused for multiple calls.
2899
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
2900
+ #
2901
+ # # Create a request. To set request fields, pass in keyword arguments.
2902
+ # request = Google::Cloud::Kms::V1::AsymmetricDecryptRequest.new
2903
+ #
2904
+ # # Call the asymmetric_decrypt method.
2905
+ # result = client.asymmetric_decrypt request
2906
+ #
2907
+ # # The returned object is of type Google::Cloud::Kms::V1::AsymmetricDecryptResponse.
2908
+ # p result
2909
+ #
2494
2910
  def asymmetric_decrypt request, options = nil
2495
2911
  raise ::ArgumentError, "request must be provided" if request.nil?
2496
2912
 
@@ -2578,6 +2994,22 @@ module Google
2578
2994
  # @return [::Google::Cloud::Kms::V1::MacSignResponse]
2579
2995
  #
2580
2996
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
2997
+ #
2998
+ # @example Basic example
2999
+ # require "google/cloud/kms/v1"
3000
+ #
3001
+ # # Create a client object. The client can be reused for multiple calls.
3002
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
3003
+ #
3004
+ # # Create a request. To set request fields, pass in keyword arguments.
3005
+ # request = Google::Cloud::Kms::V1::MacSignRequest.new
3006
+ #
3007
+ # # Call the mac_sign method.
3008
+ # result = client.mac_sign request
3009
+ #
3010
+ # # The returned object is of type Google::Cloud::Kms::V1::MacSignResponse.
3011
+ # p result
3012
+ #
2581
3013
  def mac_sign request, options = nil
2582
3014
  raise ::ArgumentError, "request must be provided" if request.nil?
2583
3015
 
@@ -2687,6 +3119,22 @@ module Google
2687
3119
  # @return [::Google::Cloud::Kms::V1::MacVerifyResponse]
2688
3120
  #
2689
3121
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3122
+ #
3123
+ # @example Basic example
3124
+ # require "google/cloud/kms/v1"
3125
+ #
3126
+ # # Create a client object. The client can be reused for multiple calls.
3127
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
3128
+ #
3129
+ # # Create a request. To set request fields, pass in keyword arguments.
3130
+ # request = Google::Cloud::Kms::V1::MacVerifyRequest.new
3131
+ #
3132
+ # # Call the mac_verify method.
3133
+ # result = client.mac_verify request
3134
+ #
3135
+ # # The returned object is of type Google::Cloud::Kms::V1::MacVerifyResponse.
3136
+ # p result
3137
+ #
2690
3138
  def mac_verify request, options = nil
2691
3139
  raise ::ArgumentError, "request must be provided" if request.nil?
2692
3140
 
@@ -2759,6 +3207,22 @@ module Google
2759
3207
  # @return [::Google::Cloud::Kms::V1::GenerateRandomBytesResponse]
2760
3208
  #
2761
3209
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
3210
+ #
3211
+ # @example Basic example
3212
+ # require "google/cloud/kms/v1"
3213
+ #
3214
+ # # Create a client object. The client can be reused for multiple calls.
3215
+ # client = Google::Cloud::Kms::V1::KeyManagementService::Rest::Client.new
3216
+ #
3217
+ # # Create a request. To set request fields, pass in keyword arguments.
3218
+ # request = Google::Cloud::Kms::V1::GenerateRandomBytesRequest.new
3219
+ #
3220
+ # # Call the generate_random_bytes method.
3221
+ # result = client.generate_random_bytes request
3222
+ #
3223
+ # # The returned object is of type Google::Cloud::Kms::V1::GenerateRandomBytesResponse.
3224
+ # p result
3225
+ #
2762
3226
  def generate_random_bytes request, options = nil
2763
3227
  raise ::ArgumentError, "request must be provided" if request.nil?
2764
3228
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Kms
23
23
  module V1
24
- VERSION = "0.22.0"
24
+ VERSION = "0.23.0"
25
25
  end
26
26
  end
27
27
  end
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
@@ -386,11 +386,11 @@ module Google
386
386
  # {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
387
387
  # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ENCRYPT_DECRYPT ENCRYPT_DECRYPT}.
388
388
  #
389
- # Algorithms beginning with "RSA_SIGN_" are usable with
389
+ # Algorithms beginning with `RSA_SIGN_` are usable with
390
390
  # {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
391
391
  # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_SIGN ASYMMETRIC_SIGN}.
392
392
  #
393
- # The fields in the name after "RSA_SIGN_" correspond to the following
393
+ # The fields in the name after `RSA_SIGN_` correspond to the following
394
394
  # parameters: padding algorithm, modulus bit length, and digest algorithm.
395
395
  #
396
396
  # For PSS, the salt length used is equal to the length of digest
@@ -398,25 +398,25 @@ module Google
398
398
  # {::Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionAlgorithm::RSA_SIGN_PSS_2048_SHA256 RSA_SIGN_PSS_2048_SHA256}
399
399
  # will use PSS with a salt length of 256 bits or 32 bytes.
400
400
  #
401
- # Algorithms beginning with "RSA_DECRYPT_" are usable with
401
+ # Algorithms beginning with `RSA_DECRYPT_` are usable with
402
402
  # {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
403
403
  # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_DECRYPT ASYMMETRIC_DECRYPT}.
404
404
  #
405
- # The fields in the name after "RSA_DECRYPT_" correspond to the following
405
+ # The fields in the name after `RSA_DECRYPT_` correspond to the following
406
406
  # parameters: padding algorithm, modulus bit length, and digest algorithm.
407
407
  #
408
- # Algorithms beginning with "EC_SIGN_" are usable with
408
+ # Algorithms beginning with `EC_SIGN_` are usable with
409
409
  # {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
410
410
  # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::ASYMMETRIC_SIGN ASYMMETRIC_SIGN}.
411
411
  #
412
- # The fields in the name after "EC_SIGN_" correspond to the following
412
+ # The fields in the name after `EC_SIGN_` correspond to the following
413
413
  # parameters: elliptic curve, digest algorithm.
414
414
  #
415
- # Algorithms beginning with "HMAC_" are usable with
415
+ # Algorithms beginning with `HMAC_` are usable with
416
416
  # {::Google::Cloud::Kms::V1::CryptoKey#purpose CryptoKey.purpose}
417
417
  # {::Google::Cloud::Kms::V1::CryptoKey::CryptoKeyPurpose::MAC MAC}.
418
418
  #
419
- # The suffix following "HMAC_" corresponds to the hash algorithm being used
419
+ # The suffix following `HMAC_` corresponds to the hash algorithm being used
420
420
  # (eg. SHA256).
421
421
  #
422
422
  # For more information, see [Key purposes and algorithms]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-kms-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.22.0
4
+ version: 0.23.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-07-25 00:00:00.000000000 Z
11
+ date: 2023-09-12 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.19.1
19
+ version: 0.20.0
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.19.1
29
+ version: 0.20.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -270,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
270
270
  - !ruby/object:Gem::Version
271
271
  version: '0'
272
272
  requirements: []
273
- rubygems_version: 3.4.2
273
+ rubygems_version: 3.4.19
274
274
  signing_key:
275
275
  specification_version: 4
276
276
  summary: Manages keys and performs cryptographic operations in a central cloud service,