Package com.google.cloud.kms.v1

Interface RawEncryptRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RawEncryptRequest, RawEncryptRequest.Builder
    public interface RawEncryptRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Required. The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.
        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
 encryption.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for name.

      • getPlaintext

        com.google.protobuf.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

        com.google.protobuf.ByteString getAdditionalAuthenticatedData()
         Optional. Optional data that, if specified, must also be provided during
 decryption through
 [RawDecryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawDecryptRequest.additional_authenticated_data].

 This field may only be used in conjunction with an
 [algorithm][google.cloud.kms.v1.CryptoKeyVersion.algorithm] that accepts
 additional authenticated data (for example, AES-GCM).

 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 additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The additionalAuthenticatedData.

      • hasPlaintextCrc32C

        boolean hasPlaintextCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.plaintext][google.cloud.kms.v1.RawEncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received 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(plaintext) is equal
 to 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the plaintextCrc32c field is set.

      • getPlaintextCrc32C

        com.google.protobuf.Int64Value getPlaintextCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.plaintext][google.cloud.kms.v1.RawEncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received 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(plaintext) is equal
 to 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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The plaintextCrc32c.

      • getPlaintextCrc32COrBuilder

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

      • hasAdditionalAuthenticatedDataCrc32C

        boolean hasAdditionalAuthenticatedDataCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.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 = 5 [(.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
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The additionalAuthenticatedDataCrc32c.

      • getAdditionalAuthenticatedDataCrc32COrBuilder

        com.google.protobuf.Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.additional_authenticated_data][google.cloud.kms.v1.RawEncryptRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getInitializationVector

        com.google.protobuf.ByteString getInitializationVector()
         Optional. A customer-supplied initialization vector that will be used for
 encryption. If it is not provided for AES-CBC and AES-CTR, one will be
 generated. It will be returned in
 [RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
        bytes initialization_vector = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The initializationVector.

      • hasInitializationVectorCrc32C

        boolean hasInitializationVectorCrc32C()
         Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.initialization_vector][google.cloud.kms.v1.RawEncryptRequest.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 = 7 [(.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
 [RawEncryptRequest.initialization_vector][google.cloud.kms.v1.RawEncryptRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The initializationVectorCrc32c.

      • getInitializationVectorCrc32COrBuilder

        com.google.protobuf.Int64ValueOrBuilder getInitializationVectorCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [RawEncryptRequest.initialization_vector][google.cloud.kms.v1.RawEncryptRequest.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 = 7 [(.google.api.field_behavior) = OPTIONAL];