3.27.0 (latest) 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0

    public sealed class EncryptRequest : IMessage<EncryptRequest>, IEquatable<EncryptRequest>, IDeepCloneable<EncryptRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Key Management Service v1 API class EncryptRequest.

Request message for
\[KeyManagementService.Encrypt\]\[google.cloud.kms.v1.KeyManagementService.Encrypt\].

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> EncryptRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[EncryptRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EncryptRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[EncryptRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EncryptRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[EncryptRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EncryptRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Kms.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1)

## Assembly

Google.Cloud.Kms.V1.dll

## Constructors

### EncryptRequest()

    public EncryptRequest()

### EncryptRequest(EncryptRequest)

    public EncryptRequest(EncryptRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EncryptRequest` |

## Properties

### AdditionalAuthenticatedData

    public ByteString AdditionalAuthenticatedData { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.ByteString.html` |   |

### AdditionalAuthenticatedDataCrc32C

    public long? AdditionalAuthenticatedDataCrc32C { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### Name

    public string Name { get; set; }

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\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Plaintext

    public ByteString Plaintext { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.ByteString.html` |   |

### PlaintextCrc32C

    public long? PlaintextCrc32C { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### ResourceName

    public IResourceName ResourceName { get; set; }

[IResourceName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Kms.V1/latest/Google.Cloud.Kms.V1.EncryptRequest#Google_Cloud_Kms_V1_EncryptRequest_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.IResourceName.html` |   |