Reference documentation and code samples for the Cloud Key Management Service (KMS) V1 API class Google::Cloud::Kms::V1::RawEncryptResponse.
Response message for KeyManagementService.RawEncrypt.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ciphertext
def ciphertext() -> ::String
Returns
- (::String) — The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.
#ciphertext=
def ciphertext=(value) -> ::String
Parameter
- value (::String) — The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.
Returns
- (::String) — The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.
#ciphertext_crc32c
def ciphertext_crc32c() -> ::Google::Protobuf::Int64Value
Returns
- (::Google::Protobuf::Int64Value) — Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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 RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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 RawEncryptResponse.ciphertext. An integrity check of ciphertext can be performed by computing the CRC32C checksum of 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.
#initialization_vector
def initialization_vector() -> ::String
Returns
- (::String) — The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.
#initialization_vector=
def initialization_vector=(value) -> ::String
Parameter
- value (::String) — The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.
Returns
- (::String) — The initialization vector (IV) generated by the service during encryption. This value must be stored and provided in RawDecryptRequest.initialization_vector at decryption time.
#initialization_vector_crc32c
def initialization_vector_crc32c() -> ::Google::Protobuf::Int64Value
Returns
- (::Google::Protobuf::Int64Value) — Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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.
#initialization_vector_crc32c=
def initialization_vector_crc32c=(value) -> ::Google::Protobuf::Int64Value
Parameter
- value (::Google::Protobuf::Int64Value) — Integrity verification field. A CRC32C checksum of the returned RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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 RawEncryptResponse.initialization_vector. An integrity check of initialization_vector can be performed by computing the CRC32C checksum of initialization_vector 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.
#tag_length
def tag_length() -> ::Integer
Returns
- (::Integer) — The length of the authentication tag that is appended to the end of the ciphertext.
#tag_length=
def tag_length=(value) -> ::Integer
Parameter
- value (::Integer) — The length of the authentication tag that is appended to the end of the ciphertext.
Returns
- (::Integer) — The length of the authentication tag that is appended to the end of the ciphertext.
#verified_additional_authenticated_data_crc32c
def verified_additional_authenticated_data_crc32c() -> ::Boolean
Returns
- (::Boolean) — Integrity verification field. A flag indicating whether RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.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 RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.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 RawEncryptRequest.additional_authenticated_data_crc32c was received by KeyManagementService and used for the integrity verification of additional_authenticated_data. A false value of this field indicates either that // RawEncryptRequest.additional_authenticated_data_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.additional_authenticated_data_crc32c but this field is still false, discard the response and perform a limited number of retries.
#verified_initialization_vector_crc32c
def verified_initialization_vector_crc32c() -> ::Boolean
Returns
- (::Boolean) — Integrity verification field. A flag indicating whether RawEncryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.initialization_vector_crc32c but this field is still false, discard the response and perform a limited number of retries.
#verified_initialization_vector_crc32c=
def verified_initialization_vector_crc32c=(value) -> ::Boolean
Parameter
- value (::Boolean) — Integrity verification field. A flag indicating whether RawEncryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.initialization_vector_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 RawEncryptRequest.initialization_vector_crc32c was received by KeyManagementService and used for the integrity verification of initialization_vector. A false value of this field indicates either that RawEncryptRequest.initialization_vector_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.initialization_vector_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 RawEncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.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 RawEncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.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 RawEncryptRequest.plaintext_crc32c was received by KeyManagementService and used for the integrity verification of the plaintext. A false value of this field indicates either that RawEncryptRequest.plaintext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set RawEncryptRequest.plaintext_crc32c but this field is still false, discard the response and perform a limited number of retries.