Package com.google.cloud.kms.v1

Interface DecapsulateResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DecapsulateResponse, DecapsulateResponse.Builder
@Generated public interface DecapsulateResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for decapsulation.
    com.google.protobuf.ByteString
    getNameBytes()
    The resource name of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used for decapsulation.
    ProtectionLevel
    getProtectionLevel()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in decapsulation.
    int
    getProtectionLevelValue()
    The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in decapsulation.
    com.google.protobuf.ByteString
    getSharedSecret()
    The decapsulated shared_secret originally encapsulated with the matching public key.
    long
    getSharedSecretCrc32C()
    Integrity verification field.
    boolean
    getVerifiedCiphertextCrc32C()
    Integrity verification field.
    boolean
    hasSharedSecretCrc32C()
    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 Details

    • getName

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

    • getNameBytes

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

    • getSharedSecret

      com.google.protobuf.ByteString getSharedSecret()
       The decapsulated shared_secret originally encapsulated with the matching
 public key.
      bytes shared_secret = 2;
      Returns:
      The sharedSecret.

    • hasSharedSecretCrc32C

      boolean hasSharedSecretCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
 An integrity check of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 can be performed by computing the CRC32C checksum of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 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: receiving this response message indicates that
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
 successfully decrypt the
 [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. 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.
      optional int64 shared_secret_crc32c = 3;
      Returns:
      Whether the sharedSecretCrc32c field is set.

    • getSharedSecretCrc32C

      long getSharedSecretCrc32C()
       Integrity verification field. A CRC32C checksum of the returned
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret].
 An integrity check of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 can be performed by computing the CRC32C checksum of
 [DecapsulateResponse.shared_secret][google.cloud.kms.v1.DecapsulateResponse.shared_secret]
 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: receiving this response message indicates that
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] is able to
 successfully decrypt the
 [ciphertext][google.cloud.kms.v1.DecapsulateRequest.ciphertext]. 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.
      optional int64 shared_secret_crc32c = 3;
      Returns:
      The sharedSecretCrc32c.

    • getVerifiedCiphertextCrc32C

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

    • getProtectionLevelValue

      int getProtectionLevelValue()
       The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 decapsulation.
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      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
 decapsulation.
      .google.cloud.kms.v1.ProtectionLevel protection_level = 5;
      Returns:
      The protectionLevel.