Package com.google.cloud.kms.v1

Interface EncryptResponseOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.ByteString getCiphertext()
      The encrypted data.
      com.google.protobuf.Int64Value getCiphertextCrc32C()
      Integrity verification field.
      com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder()
      Integrity verification field.
      String getName()
      The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
      com.google.protobuf.ByteString getNameBytes()
      The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
      ProtectionLevel getProtectionLevel()
      The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
      int getProtectionLevelValue()
      The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in encryption.
      boolean getVerifiedAdditionalAuthenticatedDataCrc32C()
      Integrity verification field.
      boolean getVerifiedPlaintextCrc32C()
      Integrity verification field.
      boolean hasCiphertextCrc32C()
      Integrity verification field.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getName

        String getName()
         The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption. Check this field to verify that the intended resource was used
 for encryption.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The resource name of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption. Check this field to verify that the intended resource was used
 for encryption.
        string name = 1;
        Returns:
        The bytes for name.

      • getCiphertext

        com.google.protobuf.ByteString getCiphertext()
         The encrypted data.
        bytes ciphertext = 2;
        Returns:
        The ciphertext.

      • hasCiphertextCrc32C

        boolean hasCiphertextCrc32C()
         Integrity verification field. A CRC32C checksum of the returned
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext].
 An integrity check of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 can be performed by computing the CRC32C checksum of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.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:
        Whether the ciphertextCrc32c field is set.

      • getCiphertextCrc32C

        com.google.protobuf.Int64Value getCiphertextCrc32C()
         Integrity verification field. A CRC32C checksum of the returned
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext].
 An integrity check of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 can be performed by computing the CRC32C checksum of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.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:
        The ciphertextCrc32c.

      • getCiphertextCrc32COrBuilder

        com.google.protobuf.Int64ValueOrBuilder getCiphertextCrc32COrBuilder()
         Integrity verification field. A CRC32C checksum of the returned
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext].
 An integrity check of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.ciphertext]
 can be performed by computing the CRC32C checksum of
 [EncryptResponse.ciphertext][google.cloud.kms.v1.EncryptResponse.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;

      • getVerifiedPlaintextCrc32C

        boolean getVerifiedPlaintextCrc32C()
         Integrity verification field. A flag indicating whether
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of the
 [plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]. A false value of
 this field indicates either that
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
        bool verified_plaintext_crc32c = 5;
        Returns:
        The verifiedPlaintextCrc32c.

      • getVerifiedAdditionalAuthenticatedDataCrc32C

        boolean getVerifiedAdditionalAuthenticatedDataCrc32C()
         Integrity verification field. A flag indicating whether
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of the
 [AAD][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]. A
 false value of this field indicates either that
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.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 = 6;
        Returns:
        The verifiedAdditionalAuthenticatedDataCrc32c.

      • getProtectionLevelValue

        int getProtectionLevelValue()
         The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption.
        .google.cloud.kms.v1.ProtectionLevel protection_level = 7;
        Returns:
        The enum numeric value on the wire for protectionLevel.

      • getProtectionLevel

        ProtectionLevel getProtectionLevel()
         The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 encryption.
        .google.cloud.kms.v1.ProtectionLevel protection_level = 7;
        Returns:
        The protectionLevel.