Cloud Key Management Service (KMS) V1 API - Class Google::Cloud::Kms::V1::RawDecryptRequest (v0.23.0)

Version 0.23.0

• 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::RawDecryptRequest.

Request message for KeyManagementService.RawDecrypt.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#additional_authenticated_data

def additional_authenticated_data() -> ::String

Returns

• (::String) — Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data.

#additional_authenticated_data=

def additional_authenticated_data=(value) -> ::String

Parameter

• value (::String) — Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data.

Returns

• (::String) — Optional. Optional data that must match the data originally supplied in RawEncryptRequest.additional_authenticated_data.

#additional_authenticated_data_crc32c

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

Returns

• (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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.

#additional_authenticated_data_crc32c=

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

Parameter

• value (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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) — Optional. An optional CRC32C checksum of the RawDecryptRequest.additional_authenticated_data. If specified, KeyManagementService will verify the integrity of the received additional_authenticated_data using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(additional_authenticated_data) is equal to additional_authenticated_data_crc32c, and if so, 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

def ciphertext() -> ::String

Returns

• (::String) — Required. The encrypted data originally returned in RawEncryptResponse.ciphertext.

#ciphertext=

def ciphertext=(value) -> ::String

Parameter

• value (::String) — Required. The encrypted data originally returned in RawEncryptResponse.ciphertext.

Returns

• (::String) — Required. The encrypted data originally returned in RawEncryptResponse.ciphertext.

#ciphertext_crc32c

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

Returns

• (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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) — Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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) — Optional. An optional CRC32C checksum of the RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify the integrity of the received ciphertext using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, 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) — Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

#initialization_vector=

def initialization_vector=(value) -> ::String

Parameter

• value (::String) — Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

Returns

• (::String) — Required. The initialization vector (IV) used during encryption, which must match the data originally provided in RawEncryptResponse.initialization_vector.

#initialization_vector_crc32c

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

Returns

• (::Google::Protobuf::Int64Value) — Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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) — Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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) — Optional. An optional CRC32C checksum of the RawDecryptRequest.initialization_vector. If specified, KeyManagementService will verify the integrity of the received initialization_vector using this checksum. KeyManagementService will report an error if the checksum verification fails. If you receive a checksum error, your client should verify that CRC32C(initialization_vector) is equal to initialization_vector_crc32c, and if so, 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) — Required. The resource name of the CryptoKeyVersion to use for decryption.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Required. The resource name of the CryptoKeyVersion to use for decryption.

Returns

• (::String) — Required. The resource name of the CryptoKeyVersion to use for decryption.

#tag_length

def tag_length() -> ::Integer

Returns

• (::Integer) — The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).

#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. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).

Returns

• (::Integer) — The length of the authentication tag that is appended to the end of the ciphertext. If unspecified (0), the default value for the key's algorithm will be used (for AES-GCM, the default value is 16).