Interface RawEncryptResponseOrBuilder (2.36.0)

public interface RawEncryptResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCiphertext()

public abstract ByteString getCiphertext()

The encrypted data. In the case of AES-GCM, the authentication tag is the tag_length bytes at the end of this field.

bytes ciphertext = 1;

Returns
Type	Description
`ByteString`	The ciphertext.

getCiphertextCrc32C()

public abstract Int64Value getCiphertextCrc32C()

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.

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
Type	Description
`Int64Value`	The ciphertextCrc32c.

getCiphertextCrc32COrBuilder()

public abstract Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
Type	Description
`Int64ValueOrBuilder`

getInitializationVector()

public abstract ByteString getInitializationVector()

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

bytes initialization_vector = 2;

Returns
Type	Description
`ByteString`	The initializationVector.

getInitializationVectorCrc32C()

public abstract Int64Value getInitializationVectorCrc32C()

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.

.google.protobuf.Int64Value initialization_vector_crc32c = 5;

Returns
Type	Description
`Int64Value`	The initializationVectorCrc32c.

getInitializationVectorCrc32COrBuilder()

public abstract Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()

.google.protobuf.Int64Value initialization_vector_crc32c = 5;

Returns
Type	Description
`Int64ValueOrBuilder`

getName()

public abstract String getName()

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

string name = 8;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 8;

Returns
Type	Description
`ByteString`	The bytes for name.

getProtectionLevel()

public abstract ProtectionLevel getProtectionLevel()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

Returns
Type	Description
`ProtectionLevel`	The protectionLevel.

getProtectionLevelValue()

public abstract int getProtectionLevelValue()

The ProtectionLevel of the CryptoKeyVersion used in encryption.

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

Returns
Type	Description
`int`	The enum numeric value on the wire for protectionLevel.

getTagLength()

public abstract int getTagLength()

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

int32 tag_length = 3;

Returns
Type	Description
`int`	The tagLength.

getVerifiedAdditionalAuthenticatedDataCrc32C()

public abstract boolean getVerifiedAdditionalAuthenticatedDataCrc32C()

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.

bool verified_additional_authenticated_data_crc32c = 7;

Returns
Type	Description
`boolean`	The verifiedAdditionalAuthenticatedDataCrc32c.

getVerifiedInitializationVectorCrc32C()

public abstract boolean getVerifiedInitializationVectorCrc32C()

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.

bool verified_initialization_vector_crc32c = 10;

Returns
Type	Description
`boolean`	The verifiedInitializationVectorCrc32c.

getVerifiedPlaintextCrc32C()

public abstract boolean getVerifiedPlaintextCrc32C()

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.

bool verified_plaintext_crc32c = 6;

Returns
Type	Description
`boolean`	The verifiedPlaintextCrc32c.

hasCiphertextCrc32C()

public abstract boolean hasCiphertextCrc32C()

.google.protobuf.Int64Value ciphertext_crc32c = 4;

Returns
Type	Description
`boolean`	Whether the ciphertextCrc32c field is set.

hasInitializationVectorCrc32C()

public abstract boolean hasInitializationVectorCrc32C()

.google.protobuf.Int64Value initialization_vector_crc32c = 5;

Returns
Type	Description
`boolean`	Whether the initializationVectorCrc32c field is set.