Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::KeyManagementService::Rest::ServiceStub.
REST service stub for the KeyManagementService service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#asymmetric_decrypt
def asymmetric_decrypt(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::AsymmetricDecryptResponse
Baseline implementation for the asymmetric_decrypt REST call
- request_pb (::Google::Cloud::Kms::V1::AsymmetricDecryptRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::AsymmetricDecryptResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::AsymmetricDecryptResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#asymmetric_sign
def asymmetric_sign(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::AsymmetricSignResponse
Baseline implementation for the asymmetric_sign REST call
- request_pb (::Google::Cloud::Kms::V1::AsymmetricSignRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::AsymmetricSignResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::AsymmetricSignResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_crypto_key
def create_crypto_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::CryptoKey
Baseline implementation for the create_crypto_key REST call
- request_pb (::Google::Cloud::Kms::V1::CreateCryptoKeyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKey)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKey) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_crypto_key_version
def 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
- request_pb (::Google::Cloud::Kms::V1::CreateCryptoKeyVersionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKeyVersion)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKeyVersion) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_import_job
def create_import_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::ImportJob
Baseline implementation for the create_import_job REST call
- request_pb (::Google::Cloud::Kms::V1::CreateImportJobRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::ImportJob)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::ImportJob) — A result object deserialized from the server's reply
- (::ArgumentError)
#create_key_ring
def create_key_ring(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::KeyRing
Baseline implementation for the create_key_ring REST call
- request_pb (::Google::Cloud::Kms::V1::CreateKeyRingRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::KeyRing)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::KeyRing) — A result object deserialized from the server's reply
- (::ArgumentError)
#decrypt
def decrypt(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::DecryptResponse
Baseline implementation for the decrypt REST call
- request_pb (::Google::Cloud::Kms::V1::DecryptRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::DecryptResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::DecryptResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#destroy_crypto_key_version
def 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
- request_pb (::Google::Cloud::Kms::V1::DestroyCryptoKeyVersionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKeyVersion)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKeyVersion) — A result object deserialized from the server's reply
- (::ArgumentError)
#encrypt
def encrypt(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::EncryptResponse
Baseline implementation for the encrypt REST call
- request_pb (::Google::Cloud::Kms::V1::EncryptRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::EncryptResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::EncryptResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#endpoint
def endpoint() -> String
The effective endpoint
- (String)
#generate_random_bytes
def generate_random_bytes(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::GenerateRandomBytesResponse
Baseline implementation for the generate_random_bytes REST call
- request_pb (::Google::Cloud::Kms::V1::GenerateRandomBytesRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::GenerateRandomBytesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::GenerateRandomBytesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_crypto_key
def get_crypto_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::CryptoKey
Baseline implementation for the get_crypto_key REST call
- request_pb (::Google::Cloud::Kms::V1::GetCryptoKeyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKey)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKey) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_crypto_key_version
def 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
- request_pb (::Google::Cloud::Kms::V1::GetCryptoKeyVersionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKeyVersion)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKeyVersion) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_import_job
def get_import_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::ImportJob
Baseline implementation for the get_import_job REST call
- request_pb (::Google::Cloud::Kms::V1::GetImportJobRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::ImportJob)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::ImportJob) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_key_ring
def get_key_ring(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::KeyRing
Baseline implementation for the get_key_ring REST call
- request_pb (::Google::Cloud::Kms::V1::GetKeyRingRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::KeyRing)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::KeyRing) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_public_key
def get_public_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::PublicKey
Baseline implementation for the get_public_key REST call
- request_pb (::Google::Cloud::Kms::V1::GetPublicKeyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::PublicKey)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::PublicKey) — A result object deserialized from the server's reply
- (::ArgumentError)
#import_crypto_key_version
def 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
- request_pb (::Google::Cloud::Kms::V1::ImportCryptoKeyVersionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKeyVersion)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKeyVersion) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_crypto_key_versions
def 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
- request_pb (::Google::Cloud::Kms::V1::ListCryptoKeyVersionsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_crypto_keys
def list_crypto_keys(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::ListCryptoKeysResponse
Baseline implementation for the list_crypto_keys REST call
- request_pb (::Google::Cloud::Kms::V1::ListCryptoKeysRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::ListCryptoKeysResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::ListCryptoKeysResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_import_jobs
def list_import_jobs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::ListImportJobsResponse
Baseline implementation for the list_import_jobs REST call
- request_pb (::Google::Cloud::Kms::V1::ListImportJobsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::ListImportJobsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::ListImportJobsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#list_key_rings
def list_key_rings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::ListKeyRingsResponse
Baseline implementation for the list_key_rings REST call
- request_pb (::Google::Cloud::Kms::V1::ListKeyRingsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::ListKeyRingsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::ListKeyRingsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#logger
def logger(stub: false) -> Logger
The logger used for request/response debug logging.
- (Logger)
#mac_sign
def mac_sign(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::MacSignResponse
Baseline implementation for the mac_sign REST call
- request_pb (::Google::Cloud::Kms::V1::MacSignRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::MacSignResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::MacSignResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#mac_verify
def mac_verify(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::MacVerifyResponse
Baseline implementation for the mac_verify REST call
- request_pb (::Google::Cloud::Kms::V1::MacVerifyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::MacVerifyResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::MacVerifyResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#raw_decrypt
def raw_decrypt(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::RawDecryptResponse
Baseline implementation for the raw_decrypt REST call
- request_pb (::Google::Cloud::Kms::V1::RawDecryptRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::RawDecryptResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::RawDecryptResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#raw_encrypt
def raw_encrypt(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::RawEncryptResponse
Baseline implementation for the raw_encrypt REST call
- request_pb (::Google::Cloud::Kms::V1::RawEncryptRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::RawEncryptResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::RawEncryptResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#restore_crypto_key_version
def 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
- request_pb (::Google::Cloud::Kms::V1::RestoreCryptoKeyVersionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKeyVersion)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKeyVersion) — A result object deserialized from the server's reply
- (::ArgumentError)
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_crypto_key
def update_crypto_key(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Kms::V1::CryptoKey
Baseline implementation for the update_crypto_key REST call
- request_pb (::Google::Cloud::Kms::V1::UpdateCryptoKeyRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKey)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKey) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_crypto_key_primary_version
def 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
- request_pb (::Google::Cloud::Kms::V1::UpdateCryptoKeyPrimaryVersionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKey)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKey) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_crypto_key_version
def 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
- request_pb (::Google::Cloud::Kms::V1::UpdateCryptoKeyVersionRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Kms::V1::CryptoKeyVersion)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Kms::V1::CryptoKeyVersion) — A result object deserialized from the server's reply
- (::ArgumentError)