Class: Google::Cloud::Kms::V1::KeyManagementService::Rest::ServiceStub

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb

Overview

REST service stub for the KeyManagementService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Instance Method Summary collapse

Constructor Details

#initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) ⇒ ServiceStub

Returns a new instance of ServiceStub.



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 33

def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
  # These require statements are intentionally placed here to initialize
  # the REST modules only when it's required.
  require "gapic/rest"

  @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
                                               endpoint_template: endpoint_template,
                                               universe_domain: universe_domain,
                                               credentials: credentials,
                                               numeric_enums: true,
                                               raise_faraday_errors: false
end

Instance Method Details

#asymmetric_decrypt(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::AsymmetricDecryptResponse

Baseline implementation for the asymmetric_decrypt REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::AsymmetricDecryptRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 990

def asymmetric_decrypt request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_asymmetric_decrypt_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::AsymmetricDecryptResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#asymmetric_sign(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::AsymmetricSignResponse

Baseline implementation for the asymmetric_sign REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::AsymmetricSignRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 952

def asymmetric_sign request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_asymmetric_sign_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::AsymmetricSignResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#create_crypto_key(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKey

Baseline implementation for the create_crypto_key REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::CreateCryptoKeyRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 458

def create_crypto_key request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_create_crypto_key_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKey.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#create_crypto_key_version(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion

Baseline implementation for the create_crypto_key_version REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 496

def create_crypto_key_version request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_create_crypto_key_version_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKeyVersion.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#create_import_job(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::ImportJob

Baseline implementation for the create_import_job REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::CreateImportJobRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 572

def create_import_job request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_create_import_job_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::ImportJob.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#create_key_ring(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::KeyRing

Baseline implementation for the create_key_ring REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::CreateKeyRingRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 420

def create_key_ring request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_create_key_ring_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::KeyRing.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#decrypt(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::DecryptResponse

Baseline implementation for the decrypt REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::DecryptRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 838

def decrypt request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_decrypt_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::DecryptResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#destroy_crypto_key_version(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion

Baseline implementation for the destroy_crypto_key_version REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 724

def destroy_crypto_key_version request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_destroy_crypto_key_version_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKeyVersion.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#encrypt(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::EncryptResponse

Baseline implementation for the encrypt REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::EncryptRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 800

def encrypt request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_encrypt_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::EncryptResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#endpoint ⇒ String

The effective endpoint

Returns:

  • (String) 


60
61
62
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 60

def endpoint
  @client_stub.endpoint
end

#generate_random_bytes(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::GenerateRandomBytesResponse

Baseline implementation for the generate_random_bytes REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::GenerateRandomBytesRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 1104

def generate_random_bytes request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_generate_random_bytes_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::GenerateRandomBytesResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_crypto_key(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKey

Baseline implementation for the get_crypto_key REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::GetCryptoKeyRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 268

def get_crypto_key request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_crypto_key_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKey.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_crypto_key_version(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion

Baseline implementation for the get_crypto_key_version REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::GetCryptoKeyVersionRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 306

def get_crypto_key_version request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_crypto_key_version_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKeyVersion.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_import_job(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::ImportJob

Baseline implementation for the get_import_job REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::GetImportJobRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 382

def get_import_job request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_import_job_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::ImportJob.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_key_ring(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::KeyRing

Baseline implementation for the get_key_ring REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::GetKeyRingRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 230

def get_key_ring request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_key_ring_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::KeyRing.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#get_public_key(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::PublicKey

Baseline implementation for the get_public_key REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::GetPublicKeyRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 344

def get_public_key request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_get_public_key_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::PublicKey.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#import_crypto_key_version(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion

Baseline implementation for the import_crypto_key_version REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 534

def import_crypto_key_version request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_import_crypto_key_version_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKeyVersion.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_crypto_key_versions(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse

Baseline implementation for the list_crypto_key_versions REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 154

def list_crypto_key_versions request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_crypto_key_versions_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_crypto_keys(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::ListCryptoKeysResponse

Baseline implementation for the list_crypto_keys REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::ListCryptoKeysRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 116

def list_crypto_keys request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_crypto_keys_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::ListCryptoKeysResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_import_jobs(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::ListImportJobsResponse

Baseline implementation for the list_import_jobs REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::ListImportJobsRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 192

def list_import_jobs request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_import_jobs_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::ListImportJobsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#list_key_rings(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::ListKeyRingsResponse

Baseline implementation for the list_key_rings REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::ListKeyRingsRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 78

def list_key_rings request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_list_key_rings_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::ListKeyRingsResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#mac_sign(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::MacSignResponse

Baseline implementation for the mac_sign REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::MacSignRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 1028

def mac_sign request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_mac_sign_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::MacSignResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#mac_verify(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::MacVerifyResponse

Baseline implementation for the mac_verify REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::MacVerifyRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 1066

def mac_verify request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_mac_verify_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::MacVerifyResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#raw_decrypt(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::RawDecryptResponse

Baseline implementation for the raw_decrypt REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::RawDecryptRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 914

def raw_decrypt request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_raw_decrypt_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::RawDecryptResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#raw_encrypt(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::RawEncryptResponse

Baseline implementation for the raw_encrypt REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::RawEncryptRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 876

def raw_encrypt request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_raw_encrypt_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::RawEncryptResponse.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#restore_crypto_key_version(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion

Baseline implementation for the restore_crypto_key_version REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 762

def restore_crypto_key_version request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_restore_crypto_key_version_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKeyVersion.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


51
52
53
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 51

def universe_domain
  @client_stub.universe_domain
end

#update_crypto_key(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKey

Baseline implementation for the update_crypto_key REST call

Parameters:

  • request_pb (::Google::Cloud::Kms::V1::UpdateCryptoKeyRequest) —

    A request object representing the call parameters. Required.

  • options (::Gapic::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 610

def update_crypto_key request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_update_crypto_key_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKey.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#update_crypto_key_primary_version(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKey

Baseline implementation for the update_crypto_key_primary_version REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 686

def update_crypto_key_primary_version request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_update_crypto_key_primary_version_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKey.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end

#update_crypto_key_version(request_pb, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Kms::V1::CryptoKeyVersion

Baseline implementation for the update_crypto_key_version REST call

Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::ArgumentError) 


648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/google/cloud/kms/v1/key_management_service/rest/service_stub.rb', line 648

def update_crypto_key_version request_pb, options = nil
  raise ::ArgumentError, "request must be provided" if request_pb.nil?

  verb, uri, query_string_params, body = ServiceStub.transcode_update_crypto_key_version_request request_pb
  query_string_params = if query_string_params.any?
                          query_string_params.to_h { |p| p.split "=", 2 }
                        else
                          {}
                        end

  response = @client_stub.make_http_request(
    verb,
    uri:     uri,
    body:    body || "",
    params:  query_string_params,
    options: options
  )
  operation = ::Gapic::Rest::TransportOperation.new response
  result = ::Google::Cloud::Kms::V1::CryptoKeyVersion.decode_json response.body, ignore_unknown_fields: true

  yield result, operation if block_given?
  result
end