lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb in google-cloud-kms-0.2.2 vs lib/google/cloud/kms/v1/doc/google/cloud/kms/v1/service.rb in google-cloud-kms-0.2.3

- old
+ new

@@ -47,10 +47,13 @@ # request. If unspecified, the server will pick an appropriate default. # @!attribute [rw] page_token # @return [String] # Optional pagination token, returned earlier via # {Google::Cloud::Kms::V1::ListCryptoKeysResponse#next_page_token ListCryptoKeysResponse#next_page_token}. + # @!attribute [rw] version_view + # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView] + # The fields of the primary version to include in the response. class ListCryptoKeysRequest; end # Request message for {Google::Cloud::Kms::V1::KeyManagementService::ListCryptoKeyVersions KeyManagementService::ListCryptoKeyVersions}. # @!attribute [rw] parent # @return [String] @@ -65,10 +68,13 @@ # If unspecified, the server will pick an appropriate default. # @!attribute [rw] page_token # @return [String] # Optional pagination token, returned earlier via # {Google::Cloud::Kms::V1::ListCryptoKeyVersionsResponse#next_page_token ListCryptoKeyVersionsResponse#next_page_token}. + # @!attribute [rw] view + # @return [Google::Cloud::Kms::V1::CryptoKeyVersion::CryptoKeyVersionView] + # The fields to include in the response. class ListCryptoKeyVersionsRequest; end # Response message for {Google::Cloud::Kms::V1::KeyManagementService::ListKeyRings KeyManagementService::ListKeyRings}. # @!attribute [rw] key_rings # @return [Array<Google::Cloud::Kms::V1::KeyRing>] @@ -126,10 +132,17 @@ # @!attribute [rw] name # @return [String] # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to get. class GetCryptoKeyVersionRequest; end + # Request message for {Google::Cloud::Kms::V1::KeyManagementService::GetPublicKey KeyManagementService::GetPublicKey}. + # @!attribute [rw] name + # @return [String] + # The {Google::Cloud::Kms::V1::CryptoKeyVersion#name name} of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} public key to + # get. + class GetPublicKeyRequest; end + # Request message for {Google::Cloud::Kms::V1::KeyManagementService::CreateKeyRing KeyManagementService::CreateKeyRing}. # @!attribute [rw] parent # @return [String] # Required. The resource name of the location associated with the # {Google::Cloud::Kms::V1::KeyRing KeyRings}, in the format +projects/*/locations/*+. @@ -193,15 +206,28 @@ # If a {Google::Cloud::Kms::V1::CryptoKey CryptoKey} is specified, the server will use its # {Google::Cloud::Kms::V1::CryptoKey#primary primary version}. # @!attribute [rw] plaintext # @return [String] # Required. The data to encrypt. Must be no larger than 64KiB. + # + # The maximum size depends on the key version's + # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}. For + # {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the plaintext must be no larger + # than 64KiB. For {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of the + # plaintext and additional_authenticated_data fields must be no larger than + # 8KiB. # @!attribute [rw] additional_authenticated_data # @return [String] # Optional data that, if specified, must also be provided during decryption - # through {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}. Must be no - # larger than 64KiB. + # through {Google::Cloud::Kms::V1::DecryptRequest#additional_authenticated_data DecryptRequest#additional_authenticated_data}. + # + # The maximum size depends on the key version's + # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level}. For + # {Google::Cloud::Kms::V1::ProtectionLevel::SOFTWARE SOFTWARE} keys, the AAD must be no larger than + # 64KiB. For {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} keys, the combined length of the + # plaintext and additional_authenticated_data fields must be no larger than + # 8KiB. class EncryptRequest; end # Request message for {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}. # @!attribute [rw] name # @return [String] @@ -215,10 +241,32 @@ # @return [String] # Optional data that must match the data originally supplied in # {Google::Cloud::Kms::V1::EncryptRequest#additional_authenticated_data EncryptRequest#additional_authenticated_data}. class DecryptRequest; end + # Request message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}. + # @!attribute [rw] name + # @return [String] + # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for signing. + # @!attribute [rw] digest + # @return [Google::Cloud::Kms::V1::Digest] + # Required. The digest of the data to sign. The digest must be produced with + # the same digest algorithm as specified by the key version's + # {Google::Cloud::Kms::V1::CryptoKeyVersion#algorithm algorithm}. + class AsymmetricSignRequest; end + + # Request message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}. + # @!attribute [rw] name + # @return [String] + # Required. The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to use for + # decryption. + # @!attribute [rw] ciphertext + # @return [String] + # Required. The data encrypted with the named {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion}'s public + # key using OAEP. + class AsymmetricDecryptRequest; end + # Response message for {Google::Cloud::Kms::V1::KeyManagementService::Decrypt KeyManagementService::Decrypt}. # @!attribute [rw] plaintext # @return [String] # The decrypted data originally supplied in {Google::Cloud::Kms::V1::EncryptRequest#plaintext EncryptRequest#plaintext}. class DecryptResponse; end @@ -230,10 +278,22 @@ # @!attribute [rw] ciphertext # @return [String] # The encrypted data. class EncryptResponse; end + # Response message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricSign KeyManagementService::AsymmetricSign}. + # @!attribute [rw] signature + # @return [String] + # The created signature. + class AsymmetricSignResponse; end + + # Response message for {Google::Cloud::Kms::V1::KeyManagementService::AsymmetricDecrypt KeyManagementService::AsymmetricDecrypt}. + # @!attribute [rw] plaintext + # @return [String] + # The decrypted data originally encrypted with the matching public key. + class AsymmetricDecryptResponse; end + # Request message for {Google::Cloud::Kms::V1::KeyManagementService::UpdateCryptoKeyPrimaryVersion KeyManagementService::UpdateCryptoKeyPrimaryVersion}. # @!attribute [rw] name # @return [String] # The resource name of the {Google::Cloud::Kms::V1::CryptoKey CryptoKey} to update. # @!attribute [rw] crypto_key_version_id @@ -250,9 +310,29 @@ # Request message for {Google::Cloud::Kms::V1::KeyManagementService::RestoreCryptoKeyVersion KeyManagementService::RestoreCryptoKeyVersion}. # @!attribute [rw] name # @return [String] # The resource name of the {Google::Cloud::Kms::V1::CryptoKeyVersion CryptoKeyVersion} to restore. class RestoreCryptoKeyVersionRequest; end + + # A {Google::Cloud::Kms::V1::Digest Digest} holds a cryptographic message digest. + # @!attribute [rw] sha256 + # @return [String] + # A message digest produced with the SHA-256 algorithm. + # @!attribute [rw] sha384 + # @return [String] + # A message digest produced with the SHA-384 algorithm. + # @!attribute [rw] sha512 + # @return [String] + # A message digest produced with the SHA-512 algorithm. + class Digest; end + + # Cloud KMS metadata for the given {Google::Cloud::Location::Location}. + # @!attribute [rw] hsm_available + # @return [true, false] + # Indicates whether {Google::Cloud::Kms::V1::CryptoKey CryptoKeys} with + # {Google::Cloud::Kms::V1::CryptoKeyVersionTemplate#protection_level protection_level} + # {Google::Cloud::Kms::V1::ProtectionLevel::HSM HSM} can be created in this location. + class LocationMetadata; end end end end end \ No newline at end of file