Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::EncryptResponse (v1.0.2)

Version 1.0.2

• 1.2.0 (latest)
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.1
• 0.24.3
• 0.23.0
• 0.22.1
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.1
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.2

Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::EncryptResponse.

Response message for KeyManagementService.Encrypt.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#ciphertext

def ciphertext() -> ::String

Returns

• (::String) — The encrypted data.

#ciphertext=

def ciphertext=(value) -> ::String

Parameter

• value (::String) — The encrypted data.

Returns

• (::String) — The encrypted data.

#ciphertext_crc32c

def ciphertext_crc32c() -> ::Google::Protobuf::Int64Value

Returns

• (::Google::Protobuf::Int64Value) — Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

#ciphertext_crc32c=

def ciphertext_crc32c=(value) -> ::Google::Protobuf::Int64Value

Parameter

• value (::Google::Protobuf::Int64Value) — Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

Returns

• (::Google::Protobuf::Int64Value) — Integrity verification field. A CRC32C checksum of the returned EncryptResponse.ciphertext. An integrity check of EncryptResponse.ciphertext can be performed by computing the CRC32C checksum of EncryptResponse.ciphertext and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.

#name

def name() -> ::String

Returns

• (::String) — The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

Returns

• (::String) — The resource name of the CryptoKeyVersion used in encryption. Check this field to verify that the intended resource was used for encryption.

#protection_level

def protection_level() -> ::Google::Cloud::Kms::V1::ProtectionLevel

Returns

• (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion used in encryption.

#protection_level=

def protection_level=(value) -> ::Google::Cloud::Kms::V1::ProtectionLevel

Parameter

• value (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion used in encryption.

Returns

• (::Google::Cloud::Kms::V1::ProtectionLevel) — The ProtectionLevel of the CryptoKeyVersion used in encryption.

#verified_additional_authenticated_data_crc32c

def verified_additional_authenticated_data_crc32c() -> ::Boolean

Returns

• (::Boolean) — Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

#verified_additional_authenticated_data_crc32c=

def verified_additional_authenticated_data_crc32c=(value) -> ::Boolean

Parameter

• value (::Boolean) — Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns

• (::Boolean) — Integrity verification field. A flag indicating whether EncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of the AAD. A false value of this field indicates either that EncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.

#verified_plaintext_crc32c

def verified_plaintext_crc32c() -> ::Boolean

Returns

• (::Boolean) — Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.

#verified_plaintext_crc32c=

def verified_plaintext_crc32c=(value) -> ::Boolean

Parameter

• value (::Boolean) — Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.

Returns

• (::Boolean) — Integrity verification field. A flag indicating whether EncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that EncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set EncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.