com.google.cloud.kms.v1

Interface RawDecryptResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RawDecryptResponse, RawDecryptResponse.Builder

public interface RawDecryptResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.ByteString	getPlaintext() The decrypted data.
com.google.protobuf.Int64Value	getPlaintextCrc32C() Integrity verification field.
com.google.protobuf.Int64ValueOrBuilder	getPlaintextCrc32COrBuilder() Integrity verification field.
ProtectionLevel	getProtectionLevel() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in decryption.
int	getProtectionLevelValue() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in decryption.
boolean	getVerifiedAdditionalAuthenticatedDataCrc32C() Integrity verification field.
boolean	getVerifiedCiphertextCrc32C() Integrity verification field.
boolean	getVerifiedInitializationVectorCrc32C() Integrity verification field.
boolean	hasPlaintextCrc32C() Integrity verification field.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPlaintext

com.google.protobuf.ByteString getPlaintext()

 The decrypted data.
 

bytes plaintext = 1;

Returns:

The plaintext.

hasPlaintextCrc32C

boolean hasPlaintextCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [RawDecryptResponse.plaintext][google.cloud.kms.v1.RawDecryptResponse.plaintext].
 An integrity check of plaintext can be performed by computing the CRC32C
 checksum of plaintext 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][google.cloud.kms.v1.KeyManagementService] is able to
 successfully decrypt the
 [ciphertext][google.cloud.kms.v1.RawDecryptRequest.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.
 

.google.protobuf.Int64Value plaintext_crc32c = 2;

Returns:

Whether the plaintextCrc32c field is set.

getPlaintextCrc32C

com.google.protobuf.Int64Value getPlaintextCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [RawDecryptResponse.plaintext][google.cloud.kms.v1.RawDecryptResponse.plaintext].
 An integrity check of plaintext can be performed by computing the CRC32C
 checksum of plaintext 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][google.cloud.kms.v1.KeyManagementService] is able to
 successfully decrypt the
 [ciphertext][google.cloud.kms.v1.RawDecryptRequest.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.
 

.google.protobuf.Int64Value plaintext_crc32c = 2;

Returns:

The plaintextCrc32c.

getPlaintextCrc32COrBuilder

com.google.protobuf.Int64ValueOrBuilder getPlaintextCrc32COrBuilder()

 Integrity verification field. A CRC32C checksum of the returned
 [RawDecryptResponse.plaintext][google.cloud.kms.v1.RawDecryptResponse.plaintext].
 An integrity check of plaintext can be performed by computing the CRC32C
 checksum of plaintext 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][google.cloud.kms.v1.KeyManagementService] is able to
 successfully decrypt the
 [ciphertext][google.cloud.kms.v1.RawDecryptRequest.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.
 

.google.protobuf.Int64Value plaintext_crc32c = 2;

getProtectionLevelValue

int getProtectionLevelValue()

 The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 decryption.
 

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

Returns:

The enum numeric value on the wire for protectionLevel.

getProtectionLevel

ProtectionLevel getProtectionLevel()

 The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 decryption.
 

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

Returns:

The protectionLevel.

getVerifiedCiphertextCrc32C

boolean getVerifiedCiphertextCrc32C()

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

bool verified_ciphertext_crc32c = 4;

Returns:

The verifiedCiphertextCrc32c.

getVerifiedAdditionalAuthenticatedDataCrc32C

boolean getVerifiedAdditionalAuthenticatedDataCrc32C()

 Integrity verification field. A flag indicating whether
 [RawDecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of additional_authenticated_data. A false
 value of this field indicates either that //
 [RawDecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawDecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
 

bool verified_additional_authenticated_data_crc32c = 5;

Returns:

The verifiedAdditionalAuthenticatedDataCrc32c.

getVerifiedInitializationVectorCrc32C

boolean getVerifiedInitializationVectorCrc32C()

 Integrity verification field. A flag indicating whether
 [RawDecryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawDecryptRequest.initialization_vector_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of initialization_vector. A false value of
 this field indicates either that
 [RawDecryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawDecryptRequest.initialization_vector_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawDecryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawDecryptRequest.initialization_vector_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
 

bool verified_initialization_vector_crc32c = 6;

Returns:

The verifiedInitializationVectorCrc32c.