Package com.google.cloud.kms.v1

Class RawDecryptResponse

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

    • Field Detail

      • PLAINTEXT_CRC32C_FIELD_NUMBER

        public static final int PLAINTEXT_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROTECTION_LEVEL_FIELD_NUMBER

        public static final int PROTECTION_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERIFIED_CIPHERTEXT_CRC32C_FIELD_NUMBER

        public static final int VERIFIED_CIPHERTEXT_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

        public static final int VERIFIED_ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERIFIED_INITIALIZATION_VECTOR_CRC32C_FIELD_NUMBER

        public static final int VERIFIED_INITIALIZATION_VECTOR_CRC32C_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.
        bytes plaintext = 1;
        Specified by:
        getPlaintext in interface RawDecryptResponseOrBuilder
        Returns:
        The plaintext.

      • hasPlaintextCrc32C

        public boolean hasPlaintextCrc32C()
         Integrity verification field. A CRC32C checksum of the returned
 [RawDecryptResponse.plaintext][google.cloud.kms.v1.RawDecryptResponse.plaintext].
 An integrity check of plaintext can be performed by computing the CRC32C
 checksum of 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.RawDecryptRequest.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 RawDecryptResponseOrBuilder
        Returns:
        Whether the plaintextCrc32c field is set.

      • getPlaintextCrc32C

        public com.google.protobuf.Int64Value getPlaintextCrc32C()
         Integrity verification field. A CRC32C checksum of the returned
 [RawDecryptResponse.plaintext][google.cloud.kms.v1.RawDecryptResponse.plaintext].
 An integrity check of plaintext can be performed by computing the CRC32C
 checksum of 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.RawDecryptRequest.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 RawDecryptResponseOrBuilder
        Returns:
        The plaintextCrc32c.

      • getPlaintextCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getPlaintextCrc32COrBuilder()
         Integrity verification field. A CRC32C checksum of the returned
 [RawDecryptResponse.plaintext][google.cloud.kms.v1.RawDecryptResponse.plaintext].
 An integrity check of plaintext can be performed by computing the CRC32C
 checksum of 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.RawDecryptRequest.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 RawDecryptResponseOrBuilder

      • 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 = 3;
        Specified by:
        getProtectionLevelValue in interface RawDecryptResponseOrBuilder
        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 = 3;
        Specified by:
        getProtectionLevel in interface RawDecryptResponseOrBuilder
        Returns:
        The protectionLevel.

      • getVerifiedCiphertextCrc32C

        public boolean getVerifiedCiphertextCrc32C()
         Integrity verification field. A flag indicating whether
 [RawDecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.RawDecryptRequest.ciphertext_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of the ciphertext. A false value of this
 field indicates either that
 [RawDecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.RawDecryptRequest.ciphertext_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawDecryptRequest.ciphertext_crc32c][google.cloud.kms.v1.RawDecryptRequest.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 RawDecryptResponseOrBuilder
        Returns:
        The verifiedCiphertextCrc32c.

      • getVerifiedAdditionalAuthenticatedDataCrc32C

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

      • getVerifiedInitializationVectorCrc32C

        public boolean getVerifiedInitializationVectorCrc32C()
         Integrity verification field. A flag indicating whether
 [RawDecryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawDecryptRequest.initialization_vector_crc32c]
 was received by
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
 for the integrity verification of initialization_vector. A false value of
 this field indicates either that
 [RawDecryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawDecryptRequest.initialization_vector_crc32c]
 was left unset or that it was not delivered to
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
 set
 [RawDecryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawDecryptRequest.initialization_vector_crc32c]
 but this field is still false, discard the response and perform a limited
 number of retries.
        bool verified_initialization_vector_crc32c = 6;
        Specified by:
        getVerifiedInitializationVectorCrc32C in interface RawDecryptResponseOrBuilder
        Returns:
        The verifiedInitializationVectorCrc32c.

      • 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 RawDecryptResponse parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<RawDecryptResponse> 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 RawDecryptResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder