Package com.google.cloud.kms.v1

Class DecapsulateResponse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<DecapsulateResponse.Builder>
com.google.cloud.kms.v1.DecapsulateResponse.Builder
All Implemented Interfaces:
DecapsulateResponseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
DecapsulateResponse
public static final class DecapsulateResponse.Builder extends com.google.protobuf.GeneratedMessage.Builder<DecapsulateResponse.Builder> implements DecapsulateResponseOrBuilder
 Response message for
 [KeyManagementService.Decapsulate][google.cloud.kms.v1.KeyManagementService.Decapsulate].
Protobuf type google.cloud.kms.v1.DecapsulateResponse

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<DecapsulateResponse.Builder>

    • clear

      public DecapsulateResponse.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<DecapsulateResponse.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<DecapsulateResponse.Builder>

    • getDefaultInstanceForType

      public DecapsulateResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public DecapsulateResponse build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public DecapsulateResponse buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public DecapsulateResponse.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DecapsulateResponse.Builder>

    • mergeFrom

      public DecapsulateResponse.Builder mergeFrom(DecapsulateResponse other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<DecapsulateResponse.Builder>

    • mergeFrom

      public DecapsulateResponse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DecapsulateResponse.Builder>
      Throws:
      IOException

    • getName

      public 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;
      Specified by:
      getName in interface DecapsulateResponseOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface DecapsulateResponseOrBuilder
      Returns:
      The bytes for name.

    • setName

      public DecapsulateResponse.Builder setName(String value)
       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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public DecapsulateResponse.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public DecapsulateResponse.Builder setNameBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getSharedSecret

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

    • setSharedSecret

      public DecapsulateResponse.Builder setSharedSecret(com.google.protobuf.ByteString value)
       The decapsulated shared_secret originally encapsulated with the matching
 public key.
      bytes shared_secret = 2;
      Parameters:
      value - The sharedSecret to set.
      Returns:
      This builder for chaining.

    • clearSharedSecret

      public DecapsulateResponse.Builder clearSharedSecret()
       The decapsulated shared_secret originally encapsulated with the matching
 public key.
      bytes shared_secret = 2;
      Returns:
      This builder for chaining.

    • hasSharedSecretCrc32C

      public 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;
      Specified by:
      hasSharedSecretCrc32C in interface DecapsulateResponseOrBuilder
      Returns:
      Whether the sharedSecretCrc32c field is set.

    • getSharedSecretCrc32C

      public 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;
      Specified by:
      getSharedSecretCrc32C in interface DecapsulateResponseOrBuilder
      Returns:
      The sharedSecretCrc32c.

    • setSharedSecretCrc32C

      public DecapsulateResponse.Builder setSharedSecretCrc32C(long value)
       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;
      Parameters:
      value - The sharedSecretCrc32c to set.
      Returns:
      This builder for chaining.

    • clearSharedSecretCrc32C

      public DecapsulateResponse.Builder clearSharedSecretCrc32C()
       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:
      This builder for chaining.

    • getVerifiedCiphertextCrc32C

      public 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;
      Specified by:
      getVerifiedCiphertextCrc32C in interface DecapsulateResponseOrBuilder
      Returns:
      The verifiedCiphertextCrc32c.

    • setVerifiedCiphertextCrc32C

      public DecapsulateResponse.Builder setVerifiedCiphertextCrc32C(boolean value)
       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;
      Parameters:
      value - The verifiedCiphertextCrc32c to set.
      Returns:
      This builder for chaining.

    • clearVerifiedCiphertextCrc32C

      public DecapsulateResponse.Builder clearVerifiedCiphertextCrc32C()
       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:
      This builder for chaining.

    • getProtectionLevelValue

      public 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;
      Specified by:
      getProtectionLevelValue in interface DecapsulateResponseOrBuilder
      Returns:
      The enum numeric value on the wire for protectionLevel.

    • setProtectionLevelValue

      public DecapsulateResponse.Builder setProtectionLevelValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for protectionLevel to set.
      Returns:
      This builder for chaining.

    • getProtectionLevel

      public 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;
      Specified by:
      getProtectionLevel in interface DecapsulateResponseOrBuilder
      Returns:
      The protectionLevel.

    • setProtectionLevel

      public DecapsulateResponse.Builder setProtectionLevel(ProtectionLevel value)
       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;
      Parameters:
      value - The protectionLevel to set.
      Returns:
      This builder for chaining.

    • clearProtectionLevel

      public DecapsulateResponse.Builder clearProtectionLevel()
       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:
      This builder for chaining.