com.google.cloud.kms.v1

Interface RawEncryptResponseOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RawEncryptResponse, RawEncryptResponse.Builder

public interface RawEncryptResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.ByteString	getCiphertext() The encrypted data.
com.google.protobuf.Int64Value	getCiphertextCrc32C() Integrity verification field.
com.google.protobuf.Int64ValueOrBuilder	getCiphertextCrc32COrBuilder() Integrity verification field.
com.google.protobuf.ByteString	getInitializationVector() The initialization vector (IV) generated by the service during encryption.
com.google.protobuf.Int64Value	getInitializationVectorCrc32C() Integrity verification field.
com.google.protobuf.Int64ValueOrBuilder	getInitializationVectorCrc32COrBuilder() Integrity verification field.
String	getName() The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
com.google.protobuf.ByteString	getNameBytes() The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
ProtectionLevel	getProtectionLevel() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
int	getProtectionLevelValue() The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
int	getTagLength() The length of the authentication tag that is appended to the end of the ciphertext.
boolean	getVerifiedAdditionalAuthenticatedDataCrc32C() Integrity verification field.
boolean	getVerifiedInitializationVectorCrc32C() Integrity verification field.
boolean	getVerifiedPlaintextCrc32C() Integrity verification field.
boolean	hasCiphertextCrc32C() Integrity verification field.
boolean	hasInitializationVectorCrc32C() 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

getCiphertext

com.google.protobuf.ByteString getCiphertext()

 The encrypted data. In the case of AES-GCM, the authentication tag
 is the [tag_length][google.cloud.kms.v1.RawEncryptResponse.tag_length]
 bytes at the end of this field.
 

bytes ciphertext = 1;

Returns:

The ciphertext.

getInitializationVector

com.google.protobuf.ByteString getInitializationVector()

 The initialization vector (IV) generated by the service during
 encryption. This value must be stored and provided in
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector]
 at decryption time.
 

bytes initialization_vector = 2;

Returns:

The initializationVector.

getTagLength

int getTagLength()

 The length of the authentication tag that is appended to
 the end of the ciphertext.
 

int32 tag_length = 3;

Returns:

The tagLength.

hasCiphertextCrc32C

boolean hasCiphertextCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns:

Whether the ciphertextCrc32c field is set.

getCiphertextCrc32C

com.google.protobuf.Int64Value getCiphertextCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns:

The ciphertextCrc32c.

getCiphertextCrc32COrBuilder

com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

 Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value ciphertext_crc32c = 4;

hasInitializationVectorCrc32C

boolean hasInitializationVectorCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value initialization_vector_crc32c = 5;

Returns:

Whether the initializationVectorCrc32c field is set.

getInitializationVectorCrc32C

com.google.protobuf.Int64Value getInitializationVectorCrc32C()

 Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value initialization_vector_crc32c = 5;

Returns:

The initializationVectorCrc32c.

getInitializationVectorCrc32COrBuilder

com.google.protobuf.Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()

 Integrity verification field. A CRC32C checksum of the returned
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value initialization_vector_crc32c = 5;

getVerifiedPlaintextCrc32C

boolean getVerifiedPlaintextCrc32C()

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

bool verified_plaintext_crc32c = 6;

Returns:

The verifiedPlaintextCrc32c.

getVerifiedAdditionalAuthenticatedDataCrc32C

boolean getVerifiedAdditionalAuthenticatedDataCrc32C()

 Integrity verification field. A flag indicating whether
 [RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.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 //
 [RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.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 = 7;

Returns:

The verifiedAdditionalAuthenticatedDataCrc32c.

getVerifiedInitializationVectorCrc32C

boolean getVerifiedInitializationVectorCrc32C()

 Integrity verification field. A flag indicating whether
 [RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.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
 [RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
 

bool verified_initialization_vector_crc32c = 10;

Returns:

The verifiedInitializationVectorCrc32c.

getName

String getName()

 The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption. Check this field to verify that the intended resource was used
 for encryption.
 

string name = 8;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption. Check this field to verify that the intended resource was used
 for encryption.
 

string name = 8;

Returns:

The bytes for name.

getProtectionLevelValue

int getProtectionLevelValue()

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

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

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
 encryption.
 

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

Returns:

The protectionLevel.