Package com.google.cloud.kms.v1

Class EncryptResponse

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

    • Nested Class Summary

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

      • 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

      • CIPHERTEXT_FIELD_NUMBER

        public static final int CIPHERTEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CIPHERTEXT_CRC32C_FIELD_NUMBER

        public static final int CIPHERTEXT_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VERIFIED_PLAINTEXT_CRC32C_FIELD_NUMBER

        public static final int VERIFIED_PLAINTEXT_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

      • 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

      • getName

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

      • getNameBytes

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

      • getCiphertext

        public com.google.protobuf.ByteString getCiphertext()
         The encrypted data.
        bytes ciphertext = 2;
        Specified by:
        getCiphertext in interface EncryptResponseOrBuilder
        Returns:
        The ciphertext.

      • hasCiphertextCrc32C

        public 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;
        Specified by:
        hasCiphertextCrc32C in interface EncryptResponseOrBuilder
        Returns:
        Whether the ciphertextCrc32c field is set.

      • getCiphertextCrc32C

        public 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;
        Specified by:
        getCiphertextCrc32C in interface EncryptResponseOrBuilder
        Returns:
        The ciphertextCrc32c.

      • getCiphertextCrc32COrBuilder

        public 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;
        Specified by:
        getCiphertextCrc32COrBuilder in interface EncryptResponseOrBuilder

      • getVerifiedPlaintextCrc32C

        public 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;
        Specified by:
        getVerifiedPlaintextCrc32C in interface EncryptResponseOrBuilder
        Returns:
        The verifiedPlaintextCrc32c.

      • getVerifiedAdditionalAuthenticatedDataCrc32C

        public 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;
        Specified by:
        getVerifiedAdditionalAuthenticatedDataCrc32C in interface EncryptResponseOrBuilder
        Returns:
        The verifiedAdditionalAuthenticatedDataCrc32c.

      • getProtectionLevelValue

        public 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;
        Specified by:
        getProtectionLevelValue in interface EncryptResponseOrBuilder
        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
 encryption.
        .google.cloud.kms.v1.ProtectionLevel protection_level = 7;
        Specified by:
        getProtectionLevel in interface EncryptResponseOrBuilder
        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 EncryptResponse parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

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

      • getParserForType

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