com.google.cloud.kms.v1

Interface RawDecryptRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RawDecryptRequest, RawDecryptRequest.Builder

public interface RawDecryptRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.ByteString	getAdditionalAuthenticatedData() Optional.
com.google.protobuf.Int64Value	getAdditionalAuthenticatedDataCrc32C() Optional.
com.google.protobuf.Int64ValueOrBuilder	getAdditionalAuthenticatedDataCrc32COrBuilder() Optional.
com.google.protobuf.ByteString	getCiphertext() Required.
com.google.protobuf.Int64Value	getCiphertextCrc32C() Optional.
com.google.protobuf.Int64ValueOrBuilder	getCiphertextCrc32COrBuilder() Optional.
com.google.protobuf.ByteString	getInitializationVector() Required.
com.google.protobuf.Int64Value	getInitializationVectorCrc32C() Optional.
com.google.protobuf.Int64ValueOrBuilder	getInitializationVectorCrc32COrBuilder() Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
int	getTagLength() The length of the authentication tag that is appended to the end of the ciphertext.
boolean	hasAdditionalAuthenticatedDataCrc32C() Optional.
boolean	hasCiphertextCrc32C() Optional.
boolean	hasInitializationVectorCrc32C() Optional.

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

getName

String getName()

 Required. The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 decryption.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 decryption.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for name.

getCiphertext

com.google.protobuf.ByteString getCiphertext()

 Required. The encrypted data originally returned in
 [RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
 

bytes ciphertext = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The ciphertext.

getAdditionalAuthenticatedData

com.google.protobuf.ByteString getAdditionalAuthenticatedData()

 Optional. Optional data that must match the data originally supplied in
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data].
 

bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The additionalAuthenticatedData.

getInitializationVector

com.google.protobuf.ByteString getInitializationVector()

 Required. The initialization vector (IV) used during encryption, which must
 match the data originally provided in
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
 

bytes initialization_vector = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The initializationVector.

getTagLength

int getTagLength()

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

int32 tag_length = 5;

Returns:

The tagLength.

hasCiphertextCrc32C

boolean hasCiphertextCrc32C()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received ciphertext using this checksum.
 [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value ciphertext_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the ciphertextCrc32c field is set.

getCiphertextCrc32C

com.google.protobuf.Int64Value getCiphertextCrc32C()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received ciphertext using this checksum.
 [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value ciphertext_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The ciphertextCrc32c.

getCiphertextCrc32COrBuilder

com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.ciphertext][google.cloud.kms.v1.RawDecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received ciphertext using this checksum.
 [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value ciphertext_crc32c = 6 [(.google.api.field_behavior) = OPTIONAL];

hasAdditionalAuthenticatedDataCrc32C

boolean hasAdditionalAuthenticatedDataCrc32C()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received additional_authenticated_data using
 this checksum.
 [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the additionalAuthenticatedDataCrc32c field is set.

getAdditionalAuthenticatedDataCrc32C

com.google.protobuf.Int64Value getAdditionalAuthenticatedDataCrc32C()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received additional_authenticated_data using
 this checksum.
 [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The additionalAuthenticatedDataCrc32c.

getAdditionalAuthenticatedDataCrc32COrBuilder

com.google.protobuf.Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received additional_authenticated_data using
 this checksum.
 [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value additional_authenticated_data_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];

hasInitializationVectorCrc32C

boolean hasInitializationVectorCrc32C()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received initialization_vector using this
 checksum. [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value initialization_vector_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the initializationVectorCrc32c field is set.

getInitializationVectorCrc32C

com.google.protobuf.Int64Value getInitializationVectorCrc32C()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received initialization_vector using this
 checksum. [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value initialization_vector_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The initializationVectorCrc32c.

getInitializationVectorCrc32COrBuilder

com.google.protobuf.Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()

 Optional. An optional CRC32C checksum of the
 [RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received initialization_vector using this
 checksum. [KeyManagementService][google.cloud.kms.v1.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.
 

.google.protobuf.Int64Value initialization_vector_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];