com.google.cloud.kms.v1

Interface DecryptRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

DecryptRequest, DecryptRequest.Builder

public interface DecryptRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ByteString	getAdditionalAuthenticatedData() Optional.
Int64Value	getAdditionalAuthenticatedDataCrc32C() Optional.
Int64ValueOrBuilder	getAdditionalAuthenticatedDataCrc32COrBuilder() Optional.
ByteString	getCiphertext() Required.
Int64Value	getCiphertextCrc32C() Optional.
Int64ValueOrBuilder	getCiphertextCrc32COrBuilder() Optional.
String	getName() Required.
ByteString	getNameBytes() Required.
boolean	hasAdditionalAuthenticatedDataCrc32C() Optional.
boolean	hasCiphertextCrc32C() 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
 [CryptoKey][google.cloud.kms.v1.CryptoKey] to use for decryption. The
 server will choose the appropriate version.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The name.

getNameBytes

ByteString getNameBytes()

 Required. The resource name of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] to use for decryption. The
 server will choose the appropriate version.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for name.

getCiphertext

ByteString getCiphertext()

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

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

Returns:

The ciphertext.

getAdditionalAuthenticatedData

ByteString getAdditionalAuthenticatedData()

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

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

Returns:

The additionalAuthenticatedData.

hasCiphertextCrc32C

boolean hasCiphertextCrc32C()

 Optional. An optional CRC32C checksum of the
 [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.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([DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext])
 is equal to
 [DecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.DecryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the ciphertextCrc32c field is set.

getCiphertextCrc32C

Int64Value getCiphertextCrc32C()

 Optional. An optional CRC32C checksum of the
 [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.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([DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext])
 is equal to
 [DecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.DecryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The ciphertextCrc32c.

getCiphertextCrc32COrBuilder

Int64ValueOrBuilder getCiphertextCrc32COrBuilder()

 Optional. An optional CRC32C checksum of the
 [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.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([DecryptRequest.ciphertext][google.cloud.kms.v1.DecryptRequest.ciphertext])
 is equal to
 [DecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.DecryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

hasAdditionalAuthenticatedDataCrc32C

boolean hasAdditionalAuthenticatedDataCrc32C()

 Optional. An optional CRC32C checksum of the
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.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([DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data])
 is equal to
 [DecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.DecryptRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the additionalAuthenticatedDataCrc32c field is set.

getAdditionalAuthenticatedDataCrc32C

Int64Value getAdditionalAuthenticatedDataCrc32C()

 Optional. An optional CRC32C checksum of the
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.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([DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data])
 is equal to
 [DecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.DecryptRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The additionalAuthenticatedDataCrc32c.

getAdditionalAuthenticatedDataCrc32COrBuilder

Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()

 Optional. An optional CRC32C checksum of the
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.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([DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data])
 is equal to
 [DecryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.DecryptRequest.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 = 6 [(.google.api.field_behavior) = OPTIONAL];