com.google.cloud.kms.v1

Interface EncryptRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

EncryptRequest, EncryptRequest.Builder

public interface EncryptRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ByteString	getAdditionalAuthenticatedData() Optional.
Int64Value	getAdditionalAuthenticatedDataCrc32C() Optional.
Int64ValueOrBuilder	getAdditionalAuthenticatedDataCrc32COrBuilder() Optional.
String	getName() Required.
ByteString	getNameBytes() Required.
ByteString	getPlaintext() Required.
Int64Value	getPlaintextCrc32C() Optional.
Int64ValueOrBuilder	getPlaintextCrc32COrBuilder() Optional.
boolean	hasAdditionalAuthenticatedDataCrc32C() Optional.
boolean	hasPlaintextCrc32C() 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] or
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.
 If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server
 will use its [primary version][google.cloud.kms.v1.CryptoKey.primary].
 

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] or
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.
 If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server
 will use its [primary version][google.cloud.kms.v1.CryptoKey.primary].
 

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

Returns:

The bytes for name.

getPlaintext

ByteString getPlaintext()

 Required. The data to encrypt. Must be no larger than 64KiB.
 The maximum size depends on the key version's
 [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level].
 For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the
 plaintext must be no larger than 64KiB. For
 [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of
 the plaintext and additional_authenticated_data fields must be no larger
 than 8KiB.
 

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

Returns:

The plaintext.

getAdditionalAuthenticatedData

ByteString getAdditionalAuthenticatedData()

 Optional. Optional data that, if specified, must also be provided during
 decryption through
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data].
 The maximum size depends on the key version's
 [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level].
 For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE] keys, the AAD
 must be no larger than 64KiB. For
 [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of
 the plaintext and additional_authenticated_data fields must be no larger
 than 8KiB.
 

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

Returns:

The additionalAuthenticatedData.

hasPlaintextCrc32C

boolean hasPlaintextCrc32C()

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

Returns:

Whether the plaintextCrc32c field is set.

getPlaintextCrc32C

Int64Value getPlaintextCrc32C()

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

Returns:

The plaintextCrc32c.

getPlaintextCrc32COrBuilder

Int64ValueOrBuilder getPlaintextCrc32COrBuilder()

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

hasAdditionalAuthenticatedDataCrc32C

boolean hasAdditionalAuthenticatedDataCrc32C()

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

Returns:

Whether the additionalAuthenticatedDataCrc32c field is set.

getAdditionalAuthenticatedDataCrc32C

Int64Value getAdditionalAuthenticatedDataCrc32C()

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

Returns:

The additionalAuthenticatedDataCrc32c.

getAdditionalAuthenticatedDataCrc32COrBuilder

Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()

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