Package com.google.cloud.kms.v1

Class DecryptResponse

  • All Implemented Interfaces:
    DecryptResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DecryptResponse
extends com.google.protobuf.GeneratedMessageV3
implements DecryptResponseOrBuilder
     Response message for
 [KeyManagementService.Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].
    Protobuf type google.cloud.kms.v1.DecryptResponse
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DecryptResponse.Builder
      Response message for [KeyManagementService.Decrypt][google.cloud.kms.v1.KeyManagementService.Decrypt].

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • PLAINTEXT_CRC32C_FIELD_NUMBER

        public static final int PLAINTEXT_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USED_PRIMARY_FIELD_NUMBER

        public static final int USED_PRIMARY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROTECTION_LEVEL_FIELD_NUMBER

        public static final int PROTECTION_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getPlaintext

        public com.google.protobuf.ByteString getPlaintext()
         The decrypted data originally supplied in
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext].
        bytes plaintext = 1;
        Specified by:
        getPlaintext in interface DecryptResponseOrBuilder
        Returns:
        The plaintext.

      • hasPlaintextCrc32C

        public boolean hasPlaintextCrc32C()
         Integrity verification field. A CRC32C checksum of the returned
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext].
 An integrity check of
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext]
 can be performed by computing the CRC32C checksum of
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext]
 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.DecryptRequest.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.
        .google.protobuf.Int64Value plaintext_crc32c = 2;
        Specified by:
        hasPlaintextCrc32C in interface DecryptResponseOrBuilder
        Returns:
        Whether the plaintextCrc32c field is set.

      • getPlaintextCrc32C

        public com.google.protobuf.Int64Value getPlaintextCrc32C()
         Integrity verification field. A CRC32C checksum of the returned
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext].
 An integrity check of
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext]
 can be performed by computing the CRC32C checksum of
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext]
 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.DecryptRequest.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.
        .google.protobuf.Int64Value plaintext_crc32c = 2;
        Specified by:
        getPlaintextCrc32C in interface DecryptResponseOrBuilder
        Returns:
        The plaintextCrc32c.

      • getPlaintextCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getPlaintextCrc32COrBuilder()
         Integrity verification field. A CRC32C checksum of the returned
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext].
 An integrity check of
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext]
 can be performed by computing the CRC32C checksum of
 [DecryptResponse.plaintext][google.cloud.kms.v1.DecryptResponse.plaintext]
 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.DecryptRequest.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.
        .google.protobuf.Int64Value plaintext_crc32c = 2;
        Specified by:
        getPlaintextCrc32COrBuilder in interface DecryptResponseOrBuilder

      • getUsedPrimary

        public boolean getUsedPrimary()
         Whether the Decryption was performed using the primary key version.
        bool used_primary = 3;
        Specified by:
        getUsedPrimary in interface DecryptResponseOrBuilder
        Returns:
        The usedPrimary.

      • getProtectionLevelValue

        public int getProtectionLevelValue()
         The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 decryption.
        .google.cloud.kms.v1.ProtectionLevel protection_level = 4;
        Specified by:
        getProtectionLevelValue in interface DecryptResponseOrBuilder
        Returns:
        The enum numeric value on the wire for protectionLevel.

      • getProtectionLevel

        public ProtectionLevel getProtectionLevel()
         The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
 decryption.
        .google.cloud.kms.v1.ProtectionLevel protection_level = 4;
        Specified by:
        getProtectionLevel in interface DecryptResponseOrBuilder
        Returns:
        The protectionLevel.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static DecryptResponse parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DecryptResponse parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DecryptResponse parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DecryptResponse parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DecryptResponse parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DecryptResponse parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DecryptResponse parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public DecryptResponse.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public DecryptResponse.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected DecryptResponse.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<DecryptResponse> parser()

      • getParserForType

        public com.google.protobuf.Parser<DecryptResponse> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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