Interface DecapsulateResponseOrBuilder (2.77.0)

public interface DecapsulateResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getName()

public abstract String getName()

The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the CryptoKeyVersion used for decapsulation. Check this field to verify that the intended resource was used for decapsulation.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getProtectionLevel()

public abstract ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in decapsulation.

.google.cloud.kms.v1.ProtectionLevel protection_level = 5;

Returns
Type Description
ProtectionLevel

The protectionLevel.

getProtectionLevelValue()

public abstract int getProtectionLevelValue()

The ProtectionLevel of the CryptoKeyVersion used in decapsulation.

.google.cloud.kms.v1.ProtectionLevel protection_level = 5;

Returns
Type Description
int

The enum numeric value on the wire for protectionLevel.

getSharedSecret()

public abstract ByteString getSharedSecret()

The decapsulated shared_secret originally encapsulated with the matching public key.

bytes shared_secret = 2;

Returns
Type Description
ByteString

The sharedSecret.

getSharedSecretCrc32C()

public abstract long getSharedSecretCrc32C()

Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.

optional int64 shared_secret_crc32c = 3;

Returns
Type Description
long

The sharedSecretCrc32c.

getVerifiedCiphertextCrc32C()

public abstract boolean getVerifiedCiphertextCrc32C()

Integrity verification field. A flag indicating whether DecapsulateRequest.ciphertext_crc32c was received by KeyManagementService and used for the integrity verification of the ciphertext. A false value of this field indicates either that DecapsulateRequest.ciphertext_crc32c was left unset or that it was not delivered to KeyManagementService. If you've set DecapsulateRequest.ciphertext_crc32c but this field is still false, discard the response and perform a limited number of retries.

bool verified_ciphertext_crc32c = 4;

Returns
Type Description
boolean

The verifiedCiphertextCrc32c.

hasSharedSecretCrc32C()

public abstract boolean hasSharedSecretCrc32C()

Integrity verification field. A CRC32C checksum of the returned DecapsulateResponse.shared_secret. An integrity check of DecapsulateResponse.shared_secret can be performed by computing the CRC32C checksum of DecapsulateResponse.shared_secret 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: receiving this response message indicates that KeyManagementService is able to successfully decrypt the ciphertext. 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.

optional int64 shared_secret_crc32c = 3;

Returns
Type Description
boolean

Whether the sharedSecretCrc32c field is set.