Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::KeyManagementService::Rest::ServiceStub (v0.24.0)

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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#decrypt

def 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) — 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)

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#encrypt

def 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) — 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)

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#mac_sign

def 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) — 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)

#mac_verify

def 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) — 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)

#raw_decrypt

def 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) — 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)

#raw_encrypt

def 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) — 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)

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (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

Parameters
  • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)