Package com.google.cloud.kms.v1

Class EncryptRequest

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

    • Field Detail

      • ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER

        public static final int ADDITIONAL_AUTHENTICATED_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PLAINTEXT_CRC32C_FIELD_NUMBER

        public static final int PLAINTEXT_CRC32C_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ADDITIONAL_AUTHENTICATED_DATA_CRC32C_FIELD_NUMBER

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

      • getName

        public String getName()
         Required. The resource name of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] or
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.

 If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server
 will use its [primary version][google.cloud.kms.v1.CryptoKey.primary].
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface EncryptRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. The resource name of the
 [CryptoKey][google.cloud.kms.v1.CryptoKey] or
 [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] to use for
 encryption.

 If a [CryptoKey][google.cloud.kms.v1.CryptoKey] is specified, the server
 will use its [primary version][google.cloud.kms.v1.CryptoKey.primary].
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface EncryptRequestOrBuilder
        Returns:
        The bytes for name.

      • getPlaintext

        public com.google.protobuf.ByteString getPlaintext()
         Required. The data to encrypt. Must be no larger than 64KiB.

 The maximum size depends on the key version's
 [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level].
 For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE],
 [EXTERNAL][google.cloud.kms.v1.ProtectionLevel.EXTERNAL], and
 [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] keys, the
 plaintext must be no larger than 64KiB. For
 [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of
 the plaintext and additional_authenticated_data fields must be no larger
 than 8KiB.
        bytes plaintext = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getPlaintext in interface EncryptRequestOrBuilder
        Returns:
        The plaintext.

      • getAdditionalAuthenticatedData

        public com.google.protobuf.ByteString getAdditionalAuthenticatedData()
         Optional. Optional data that, if specified, must also be provided during
 decryption through
 [DecryptRequest.additional_authenticated_data][google.cloud.kms.v1.DecryptRequest.additional_authenticated_data].

 The maximum size depends on the key version's
 [protection_level][google.cloud.kms.v1.CryptoKeyVersionTemplate.protection_level].
 For [SOFTWARE][google.cloud.kms.v1.ProtectionLevel.SOFTWARE],
 [EXTERNAL][google.cloud.kms.v1.ProtectionLevel.EXTERNAL], and
 [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] keys the
 AAD must be no larger than 64KiB. For
 [HSM][google.cloud.kms.v1.ProtectionLevel.HSM] keys, the combined length of
 the plaintext and additional_authenticated_data fields must be no larger
 than 8KiB.
        bytes additional_authenticated_data = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdditionalAuthenticatedData in interface EncryptRequestOrBuilder
        Returns:
        The additionalAuthenticatedData.

      • hasPlaintextCrc32C

        public boolean hasPlaintextCrc32C()
         Optional. An optional CRC32C checksum of the
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext])
 is equal to
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c],
 and if so, 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 plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPlaintextCrc32C in interface EncryptRequestOrBuilder
        Returns:
        Whether the plaintextCrc32c field is set.

      • getPlaintextCrc32C

        public com.google.protobuf.Int64Value getPlaintextCrc32C()
         Optional. An optional CRC32C checksum of the
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext])
 is equal to
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c],
 and if so, 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 plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPlaintextCrc32C in interface EncryptRequestOrBuilder
        Returns:
        The plaintextCrc32c.

      • getPlaintextCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getPlaintextCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.plaintext][google.cloud.kms.v1.EncryptRequest.plaintext])
 is equal to
 [EncryptRequest.plaintext_crc32c][google.cloud.kms.v1.EncryptRequest.plaintext_crc32c],
 and if so, 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 plaintext_crc32c = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPlaintextCrc32COrBuilder in interface EncryptRequestOrBuilder

      • hasAdditionalAuthenticatedDataCrc32C

        public boolean hasAdditionalAuthenticatedDataCrc32C()
         Optional. An optional CRC32C checksum of the
 [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data])
 is equal to
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c],
 and if so, 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 additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasAdditionalAuthenticatedDataCrc32C in interface EncryptRequestOrBuilder
        Returns:
        Whether the additionalAuthenticatedDataCrc32c field is set.

      • getAdditionalAuthenticatedDataCrc32C

        public com.google.protobuf.Int64Value getAdditionalAuthenticatedDataCrc32C()
         Optional. An optional CRC32C checksum of the
 [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data])
 is equal to
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c],
 and if so, 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 additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdditionalAuthenticatedDataCrc32C in interface EncryptRequestOrBuilder
        Returns:
        The additionalAuthenticatedDataCrc32c.

      • getAdditionalAuthenticatedDataCrc32COrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getAdditionalAuthenticatedDataCrc32COrBuilder()
         Optional. An optional CRC32C checksum of the
 [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data].
 If specified,
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 verify the integrity of the received
 [EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data]
 using this checksum.
 [KeyManagementService][google.cloud.kms.v1.KeyManagementService] will
 report an error if the checksum verification fails. If you receive a
 checksum error, your client should verify that
 CRC32C([EncryptRequest.additional_authenticated_data][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data])
 is equal to
 [EncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.EncryptRequest.additional_authenticated_data_crc32c],
 and if so, 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 additional_authenticated_data_crc32c = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAdditionalAuthenticatedDataCrc32COrBuilder in interface EncryptRequestOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static EncryptRequest getDefaultInstance()

      • parser

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

      • getParserForType

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